Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://{youraccountname}.api-us1.com/api/3
/dealCustomFieldData/bulkUpdate
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealBulkUpdateCustomFieldDataRequest"
},
"examples": {
"Request Example": {
"value": [
{
"id": "1X",
"fieldValue": "test title"
},
{
"id": "2X",
"fieldValue": [
"option 1",
"option 3",
"option 4"
]
},
{
"id": "3X",
"fieldValue": 9999,
"fieldCurrency": "cad"
},
{
"id": "4X",
"fieldValue": "100.99"
},
{
"id": "5X",
"fieldValue": "2018-12-31"
},
{
"id": "6X",
"fieldValue": "2020-05-19T02:45:00-05:00"
}
]
}
}
}
}
}
PATCH /dealCustomFieldData/bulkUpdate
/deals/bulkUpdate
Update an existing deal
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealBulkUpdateOwnersRequest"
},
"examples": {
"Correct request": {
"value": {
"deals": [
{
"id": 1,
"ownerId": 1
},
{
"id": 2,
"ownerId": 1
},
{
"id": 3,
"ownerId": 1
}
]
}
},
"Missing ownerId": {
"value": {
"deals": [
{
"id": 1
},
{
"id": 2,
"ownerId": 2
}
]
}
},
"Non-existing deal id": {
"value": {
"deals": [
{
"id": 99999999,
"ownerId": 2
}
]
}
}
}
}
}
}
PATCH /deals/bulkUpdate
/accountCustomFieldData/bulkUpdate
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FieldBulkUpdateCustomFieldValueRequest"
},
"examples": {
"Request Example": {
"value": [
{
"id": "1",
"fieldValue": "test title"
},
{
"id": "2",
"fieldValue": [
"option 1",
"option 3",
"option 4"
]
},
{
"id": "3",
"fieldValue": 9999,
"fieldCurrency": "cad"
},
{
"id": "4",
"fieldValue": "100.99"
},
{
"id": "5",
"fieldValue": "2018-12-31"
},
{
"id": "6",
"fieldValue": "2020-05-19T02:45:00-05:00"
}
]
}
}
}
}
}
PATCH /accountCustomFieldData/bulkUpdate
AccountCreateAssociationRequest
{
"type": "object",
"properties": {
"accountContact": {
"type": "object",
"required": [
"account",
"contact"
],
"properties": {
"account": {
"type": "integer",
"format": "int32",
"description": "Account ID"
},
"contact": {
"type": "integer",
"format": "int32",
"description": "Contact ID"
},
"jobTitle": {
"type": "string",
"description": "Job Title of the contact at the account"
}
}
}
}
}
AccountCreateNewAccountRequest
{
"type": "object",
"properties": {
"account": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Account's name"
},
"owner": {
"type": "integer",
"format": "int32",
"default": 1,
"description": "The userId of the account owner."
},
"fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"customFieldId",
"fieldValue"
],
"properties": {
"fieldValue": {
"type": "string",
"description": "Updated field value. For `currency` field, this needs to be in cents not dollars (or 100 x Base Unit)."
},
"customFieldId": {
"type": "integer",
"format": "int32",
"description": "Field ID, ID of the Custom Field Meta Data"
},
"fieldCurrency": {
"type": "string",
"description": "Required only for the `currency` field type. The three letter currency code for the currency value"
}
}
},
"description": "Account's custom field values `{customFieldId: int, fieldValue: string, fieldCurrency?:string}[]`"
},
"accountUrl": {
"type": "string",
"description": "Account's website"
}
}
}
}
}
AccountUpdateAssociationRequest
{
"type": "object",
"properties": {
"accountContact": {
"type": "object",
"required": [
"account",
"contact"
],
"properties": {
"account": {
"type": "integer",
"format": "int32",
"description": "Account ID"
},
"contact": {
"type": "integer",
"format": "int32",
"description": "Contact ID"
},
"jobTitle": {
"type": "string",
"description": "Job Title of the contact at the account"
}
}
}
}
}
AccountUpdateExistingRequest
{
"type": "object",
"properties": {
"account": {
"type": "object",
"required": [],
"properties": {
"name": {
"type": "string",
"description": "Account's name"
},
"owner": {
"type": "integer",
"format": "int32",
"default": 1,
"description": "The userId of the Account owner."
},
"fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"customFieldId",
"fieldValue"
],
"properties": {
"fieldValue": {
"type": "string",
"description": "Updated field value. For `currency` field, this needs to be in cents not dollars (or 100 x Base Unit)."
},
"customFieldId": {
"type": "integer",
"format": "int32",
"description": "Field ID, ID of the Custom Field Meta Data"
},
"fieldCurrency": {
"type": "string",
"description": "Required only for the `currency` field type. The three letter currency code for the currency value"
}
}
},
"description": "Account's custom field values `{customFieldId: int, fieldValue: string, fieldCurrency?:string}[]`"
},
"accountUrl": {
"type": "string",
"description": "Account's website"
}
}
}
}
}
AddressCreateNewAddressRequest
{
"type": "object",
"properties": {
"address": {
"type": "object",
"required": [
"company_name",
"address_1",
"country"
],
"properties": {
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"global": {
"type": "string"
},
"country": {
"type": "string",
"description": "Accepts a (2) two character string - country code (eg 'US', 'CA', 'MX')"
},
"groupid": {
"type": "integer",
"format": "int32"
},
"allgroup": {
"type": "integer",
"format": "int32"
},
"district": {
"type": "string",
"description": "(Optional for countries that use it)"
},
"address_1": {
"type": "string"
},
"address_2": {
"type": "string"
},
"is_default": {
"type": "boolean",
"description": "Indicates default address"
},
"company_name": {
"type": "string"
}
}
}
}
}
AddressUpdateAddressRequest
{
"type": "object",
"properties": {
"address": {
"type": "object",
"required": [
"company_name",
"address_1",
"country"
],
"properties": {
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"global": {
"type": "string"
},
"country": {
"type": "string",
"description": "Accepts a (2) two character string - country code (eg 'US', 'CA', 'MX')"
},
"groupid": {
"type": "integer",
"format": "int32"
},
"allgroup": {
"type": "integer",
"format": "int32"
},
"district": {
"type": "string",
"description": "(Optional for countries that use it)"
},
"address_1": {
"type": "string"
},
"address_2": {
"type": "string"
},
"is_default": {
"type": "boolean",
"description": "Indicates default address"
},
"company_name": {
"type": "string"
}
}
}
}
}
BrandingUpdateExistingResourceRequest
{
"type": "object",
"properties": {
"branding": {
"type": "object",
"required": [],
"properties": {
"help": {
"type": "string"
},
"links": {
"type": "boolean",
"description": "External links. To enable (which is the default) exclude this parameter entirely. To disable (remove our branding), just pass this parameter with any value."
},
"favicon": {
"type": "string",
"description": "URL of the favicon."
},
"groupid": {
"type": "integer",
"format": "int32",
"default": 3,
"description": "The group ID. This value will always be 3."
},
"license": {
"type": "boolean",
"description": "unknown"
},
"version": {
"type": "boolean",
"description": "unknown"
},
"siteLogo": {
"type": "string"
},
"siteName": {
"type": "string",
"description": "Title of software. Example: 'ActiveCampaign Email Marketing'"
},
"copyright": {
"type": "boolean",
"description": "unknown"
},
"siteLogoSmall": {
"type": "string",
"description": "URL of small logo. Small logos appear in the header of the admin panel."
},
"footerHtmlValue": {
"type": "string",
"description": "Content of non-removeable footer. Example: <p>footer content here</p>"
},
"footerTextValue": {
"type": "string",
"description": "Content of non-removeable footer. Example: text footer content"
},
"headerHtmlValue": {
"type": "string",
"description": "Content of non-removable header. Example: <p>header content here</p>"
},
"headerTextValue": {
"type": "string",
"description": "Content of non-removable header. Example: text header content"
},
"adminTemplateCss": {
"type": "string",
"description": "The actual CSS. Example: test color: green; (ONLY AVAILABLE FOR CERTAIN PLANS)"
},
"adminTemplateHtm": {
"type": "string",
"description": "The actual HTML template (ONLY AVAILABLE FOR CERTAIN PLANS)"
},
"publicTemplateCss": {
"type": "string",
"description": "The actual CSS. Example: test color: green; (ONLY AVAILABLE FOR CERTAIN PLANS)"
},
"publicTemplateHtm": {
"type": "string",
"description": "The actual HTML template (ONLY AVAILABLE FOR CERTAIN PLANS)"
}
}
}
}
}
CalendarCreateFeedRequest
{
"type": "object",
"properties": {
"calendar": {
"type": "object",
"required": [
"title",
"type"
],
"properties": {
"type": {
"type": "string",
"description": "Possible Values: 'All', 'Deals', or 'Contacts'"
},
"title": {
"type": "string",
"description": "Title of the calendar feed"
},
"notification": {
"type": "boolean",
"description": "Whether or not this calendar has notifications"
}
}
}
}
}
CalendarUpdateFeedRequest
{
"type": "object",
"properties": {
"calendar": {
"type": "object",
"required": [],
"properties": {
"type": {
"type": "string",
"description": "Possible Values: 'All', 'Deals', or 'Contacts'"
},
"title": {
"type": "string",
"description": "Title of the calendar feed"
},
"notification": {
"type": "boolean",
"description": "Whether or not this calendar has notifications"
}
}
}
}
}
FieldBulkCreateCustomAccountFieldValueRequest
{
"type": "object",
"properties": {
"array": {
"type": "object",
"required": [
"customerAccountId",
"customFieldId",
"fieldValue"
],
"properties": {
"fieldValue": {
"type": "string",
"description": "Values for the field. (For currency field only, this needs to be in cents: eg, 10050 = 100.5)"
},
"customFieldId": {
"type": "integer",
"format": "int32",
"description": "The ID of the custom field metum this field value relates to"
},
"fieldCurrency": {
"type": "string",
"description": "Currency code for the money value"
},
"customerAccountId": {
"type": "integer",
"format": "int32",
"description": "The ID of the account this field value relates to"
}
}
}
}
}
FieldBulkUpdateCustomFieldValueRequest
{
"type": "object",
"properties": {
"array": {
"type": "object",
"required": [
"id",
"fieldValue"
],
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of the dealCustomFieldData to update"
},
"fieldValue": {
"type": "string",
"description": "Values for the field. (For currency field only, this needs to be in cents: eg, 10050 = 100.5)"
},
"fieldCurrency": {
"type": "string",
"description": "Currency code for the money value"
}
}
}
}
}
FieldCreateCustomFieldMetaRequest
{
"type": "object",
"properties": {
"accountCustomFieldMetum": {
"type": "object",
"required": [
"fieldLabel",
"fieldType"
],
"properties": {
"fieldType": {
"type": "string",
"description": "Type of field. Possible values are: `text`, `textarea`, `date`, `datetime`, `dropdown`, `multiselect`, `radio`, `checkbox`, `hidden`, `currency`, or `number`."
},
"fieldLabel": {
"type": "string",
"description": "Name of the field"
},
"displayOrder": {
"type": "integer",
"format": "int32",
"description": "Order for displaying the field on Manage Fields page and deal profiles"
},
"fieldDefault": {
"type": "string",
"description": "Default value of the field"
},
"fieldOptions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Options for the field. Only necessary if `field_type` is `dropdown`, `multiselect`, `radio`, or `checkbox`."
},
"isFormVisible": {
"type": "boolean",
"description": "Whether or not the field is visible on forms"
},
"fieldDefaultCurrency": {
"type": "string",
"description": "The 3-letter currency code of the default currency for the field. Only necessary if `field_type` is `currency`."
}
}
}
}
}
FieldCreateCustomFieldValueRequest
{
"type": "object",
"properties": {
"accountCustomFieldDatum": {
"type": "object",
"required": [
"customerAccountId",
"customFieldId",
"fieldValue"
],
"properties": {
"fieldValue": {
"type": "string",
"description": "Values for the field. (For `currency` field only, this needs to be in cents: eg, 10050 = 100.5)"
},
"customFieldId": {
"type": "integer",
"format": "int32",
"description": "The ID of the custom field metum this field value relates to"
},
"fieldCurrency": {
"type": "string",
"default": "Default Currency for Field",
"description": "Currency code for the money value"
},
"customerAccountId": {
"type": "integer",
"format": "int32",
"description": "The ID of the account this field value relates to"
}
}
}
}
}
FieldUpdateCustomFieldMetaRequest
{
"type": "object",
"properties": {
"accountCustomFieldMetum": {
"type": "object",
"required": [],
"properties": {
"fieldLabel": {
"type": "string",
"description": "Name of the field"
},
"displayOrder": {
"type": "integer",
"format": "int32",
"description": "Order for displaying the field on Manage Fields page and deal profiles"
},
"fieldDefault": {
"type": "string",
"description": "Default value of the field"
},
"fieldOptions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Options for the field. Only necessary if field_type is dropdown, multiselect, radio, or checkbox."
},
"isFormVisible": {
"type": "boolean",
"description": "Whether or not the field is visible on forms"
}
}
}
}
}
FieldUpdateCustomFieldValueRequest
{
"type": "object",
"properties": {
"accountCustomFieldDatum": {
"type": "object",
"required": [],
"properties": {
"fieldValue": {
"type": "string",
"description": "Values for text"
},
"fieldCurrency": {
"type": "string",
"default": "Default Currency for Field",
"description": "Currency code for the `currency` value"
}
}
}
}
}
MessageCreateNewMessageRequest
{
"type": "object",
"properties": {
"message": {
"type": "object",
"required": [
"fromname",
"email",
"reply2"
],
"properties": {
"email": {
"type": "string",
"description": "Email of sender"
},
"reply2": {
"type": "string",
"description": "Reply email for the recipient to reply to"
},
"subject": {
"type": "string",
"description": "Subject of message"
},
"fromname": {
"type": "string",
"description": "Name of sender"
},
"preheader_text": {
"type": "string",
"description": "Preheader Text"
}
}
}
}
}
NoteCreateAccountNoteRequest
{
"type": "object",
"properties": {
"note": {
"type": "object",
"required": [
"note"
],
"properties": {
"note": {
"type": "string",
"description": "Account note's content"
}
}
}
}
}
NoteUpdateNoteRequest
{
"type": "object",
"properties": {
"note": {
"type": "object",
"required": [
"note"
],
"properties": {
"note": {
"type": "string",
"description": "Account note's content"
}
}
}
}
}