openapi.city
Sign in

ActiveCampaign

Email marketing and CRM automation

developers.activecampaign.com/reference ↗
Version
3
OpenAPI
3.0.3
Endpoints
257
Schemas
571
69
Quality
Updated
3 days ago
Email email marketing crm automation
Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

https://{youraccountname}.api-us1.com/api/3

Endpoints

GET POST PUT PATCH DELETE

Account 10 endpoints

POST /accountContacts

Create a new account association

operationId: Account_createAssociation

Request Body

application/json
schema AccountCreateAssociationRequest
Property Type Required
accountContact object optional
└ account integer required
└ contact integer required
└ jobTitle string optional

Responses

201

201
422

422
POST /accountContacts
DELETE /accountContacts/{id}

Delete an existing account association

operationId: Account_deleteAssociation

Parameters

Name In Required Type Description
id path required integer

Association’s ID

Responses

200

200
404

404
DELETE /accountContacts/{id}
GET /accountContacts/{id}

Retrieve an existing account association

operationId: Account_getAssociation

Parameters

Name In Required Type Description
id path required integer

Association’s ID

Responses

200

200
404

404
GET /accountContacts/{id}
PUT /accountContacts/{id}

Update an existing account association

operationId: Account_updateAssociation

Parameters

Name In Required Type Description
id path required integer

Association’s ID

Request Body

application/json
schema AccountUpdateAssociationRequest
Property Type Required
accountContact object optional
└ account integer required
└ contact integer required
└ jobTitle string optional

Responses

200

200
PUT /accountContacts/{id}
POST /accounts

Create a new account

operationId: Account_createNewAccount

Request Body

application/json
schema AccountCreateNewAccountRequest
Property Type Required
account object optional
└ name string required
└ owner integer optional
└ fields array optional
└ fieldValue string required
└ customFieldId integer required
└ fieldCurrency string optional
└ accountUrl string optional

Responses

201

201
422

422
POST /accounts
DELETE /accounts/bulk_delete

Delete an existing account

operationId: Account_bulkDelete

Parameters

Name In Required Type Description
[]ids query optional integer

An integer id of the account to be deleted
[]ids query optional integer

An integer id of the account to be deleted
[]ids query optional integer

An integer id of the account to be deleted

Responses

200

200
400

400
DELETE /accounts/bulk_delete
DELETE /accounts/{id}

Delete an existing account

operationId: Account_deleteById

Parameters

Name In Required Type Description
id path required integer

Account’s id

Responses

200

200
400

400
DELETE /accounts/{id}
GET /accounts/{id}

Retrieve an existing account

operationId: Account_getById

Parameters

Name In Required Type Description
id path required integer

Account’s ID

Responses

200

200
GET /accounts/{id}
PUT /accounts/{id}

Update an existing account

operationId: Account_updateExisting

Parameters

Name In Required Type Description
id path required integer

Account’s id

Request Body

application/json
schema AccountUpdateExistingRequest
Property Type Required
account object optional
└ name string optional
└ owner integer optional
└ fields array optional
└ fieldValue string required
└ customFieldId integer required
└ fieldCurrency string optional
└ accountUrl string optional

Responses

200

200
400

400
PUT /accounts/{id}
GET /contacts/{id}/accountContacts
operationId: Account_getAccountContacts

Parameters

Name In Required Type Description
id path required integer

ID of the contact

Responses

200

200
404

404
GET /contacts/{id}/accountContacts

Address 4 endpoints

POST /addresses
operationId: Address_createNewAddress

Request Body

application/json
schema AddressCreateNewAddressRequest
Property Type Required
address object optional
└ zip string optional
└ city string optional
└ state string optional
└ global string optional
└ country string required
└ groupid integer optional
└ allgroup integer optional
└ district string optional
└ address_1 string required
└ address_2 string optional
└ is_default boolean optional
└ company_name string required

Responses

200

200
400

400
POST /addresses
DELETE /addresses/{id}
operationId: Address_deleteAddress

Parameters

Name In Required Type Description
id path required integer

ID of the Address to delete

Responses

200

200
404

404
DELETE /addresses/{id}
GET /addresses/{id}
operationId: Address_getById

Parameters

Name In Required Type Description
id path required integer

ID of the Address to retrieve

Responses

200

200
400

400
GET /addresses/{id}
PUT /addresses/{id}
operationId: Address_updateAddress

Parameters

Name In Required Type Description
id path required integer

ID of the Address being changed

Request Body

application/json
schema AddressUpdateAddressRequest
Property Type Required
address object optional
└ zip string optional
└ city string optional
└ state string optional
└ global string optional
└ country string required
└ groupid integer optional
└ allgroup integer optional
└ district string optional
└ address_1 string required
└ address_2 string optional
└ is_default boolean optional
└ company_name string required

Responses

200

200
404

404
PUT /addresses/{id}

Branding 2 endpoints

GET /brandings/{id}

Retrieve an existing branding resource

operationId: Branding_getBranding

Parameters

Name In Required Type Description
id path required integer —

Responses

200

200
400

400
GET /brandings/{id}
PUT /brandings/{id}

Update an existing branding resource

operationId: Branding_updateExistingResource

Parameters

Name In Required Type Description
id path required integer

Branding ID

Request Body

application/json
schema BrandingUpdateExistingResourceRequest
Property Type Required
branding object optional
└ help string optional
└ links boolean optional
└ favicon string optional
└ groupid integer optional
└ license boolean optional
└ version boolean optional
└ siteLogo string optional
└ siteName string optional
└ copyright boolean optional
└ siteLogoSmall string optional
└ footerHtmlValue string optional
└ footerTextValue string optional
└ headerHtmlValue string optional
└ headerTextValue string optional
└ adminTemplateCss string optional
└ adminTemplateHtm string optional
└ publicTemplateCss string optional
└ publicTemplateHtm string optional

Responses

200

200
400

400
PUT /brandings/{id}

Calendar 4 endpoints

POST /calendars
operationId: Calendar_createFeed

Request Body

application/json
schema CalendarCreateFeedRequest
Property Type Required
calendar object optional
└ type string required
└ title string required
└ notification boolean optional

Responses

200

200
POST /calendars
DELETE /calendars/{id}
operationId: Calendar_deleteFeed

Parameters

Name In Required Type Description
id path required integer

ID of the calendar feed to delete

Responses

200

200
DELETE /calendars/{id}
GET /calendars/{id}
operationId: Calendar_getFeed

Parameters

Name In Required Type Description
id path required integer

ID of the calendar feed to retrieve

Responses

200

200
404

404
GET /calendars/{id}
PUT /calendars/{id}
operationId: Calendar_updateFeed

Parameters

Name In Required Type Description
id path required integer

ID of the calendar feed to update

Request Body

application/json
schema CalendarUpdateFeedRequest
Property Type Required
calendar object optional
└ type string optional
└ title string optional
└ notification boolean optional

Responses

200

200
PUT /calendars/{id}

Campaign 2 endpoints

GET /campaigns/{id}
operationId: Campaign_getCampaignById

Parameters

Name In Required Type Description
id path required integer

ID of campaign to retrieve

Responses

200

200
GET /campaigns/{id}
GET /campaigns/{id}/links
operationId: Campaign_getLinks

Parameters

Name In Required Type Description
id path required integer

ID of campaign to retrieve Links for

Responses

200

200
404

404
GET /campaigns/{id}/links

Config 1 endpoints

PUT /configs/{id}
operationId: Config_updateSettings

Parameters

Name In Required Type Description
id path required string

ID of the config to edit

Responses

200

200
404

404
PUT /configs/{id}

Connection 4 endpoints

POST /connections

Create a new connection resource.

operationId: Connection_createNewResource

Request Body

application/json
schema ConnectionCreateNewResourceRequest

Responses

200

200
POST /connections
DELETE /connections/{id}

Delete an existing connection resource.

operationId: Connection_deleteConnectionResource

Parameters

Name In Required Type Description
id path required string

The id of the connection to delete.

Responses

200

200
400

400
DELETE /connections/{id}
GET /connections/{id}

Retrieve an existing connection resource.

operationId: Connection_getById

Parameters

Name In Required Type Description
id path required string

The id of the connection to retrieve

Responses

200

200
400

400
GET /connections/{id}
PUT /connections/{id}

Update an existing connection resource.

operationId: Connection_updateExistingConnection

Parameters

Name In Required Type Description
id path required string

The id of the connection to update

Request Body

application/json
schema ConnectionUpdateExistingConnectionRequest

Responses

200

200
400

400
PUT /connections/{id}

Contact 19 endpoints

POST /contact/sync
operationId: Contact_syncData

Request Body

application/json
schema ContactSyncDataRequest

Responses

201

201
400

400
POST /contact/sync
POST /contactAutomations
operationId: Contact_addToAutomation

Request Body

application/json
schema ContactAddToAutomationRequest

Responses

201

201
403

403
POST /contactAutomations
DELETE /contactAutomations/{id}
operationId: Contact_removeFromAutomation

Parameters

Name In Required Type Description
id path required integer

ID of the contactAutomation to delete

Responses

200

200
403

403
DELETE /contactAutomations/{id}
GET /contactAutomations/{id}
operationId: Contact_getInAutomation

Parameters

Name In Required Type Description
id path required integer

ID of the contactAutomation to retrieve

Responses

200

200
404

404
GET /contactAutomations/{id}
POST /contacts
operationId: Contact_createNewContact

Request Body

application/json
schema ContactCreateNewContactRequest

Responses

201

201
404

404
422

422
POST /contacts
DELETE /contacts/{id}

Delete an existing contact

operationId: Contact_deleteById

Parameters

Name In Required Type Description
id path required integer

The contact id

Responses

200

200
404

404
DELETE /contacts/{id}
GET /contacts/{id}

Retrieve an existing contact

operationId: Contact_getById

Parameters

Name In Required Type Description
id path required integer

ID of the contact

Responses

200

200
404

404
GET /contacts/{id}
PUT /contacts/{id}
operationId: Contact_updateContact

Parameters

Name In Required Type Description
id path required integer

ID of the contact to update

Request Body

application/json
schema ContactUpdateContactRequest

Responses

200

200
404

404
PUT /contacts/{id}
GET /contacts/{id}/automationEntryCounts
operationId: Contact_getAutomationEntryCounts

Parameters

Name In Required Type Description
id path required integer

ID of the contact

Responses

200

200
404

404
GET /contacts/{id}/automationEntryCounts
GET /contacts/{id}/bounceLogs
operationId: Contact_getBounceLogs

Parameters

Name In Required Type Description
id path required integer

ID of the contact

Responses

200

200
404

404
GET /contacts/{id}/bounceLogs
GET /contacts/{id}/contactData
operationId: Contact_getData

Parameters

Name In Required Type Description
id path required integer

ID of the contact

Responses

200

200
404

404
GET /contacts/{id}/contactData
GET /contacts/{id}/contactGoals
operationId: Contact_getGoals

Parameters

Name In Required Type Description
id path required integer

ID of the contact

Responses

200

200
404

404
GET /contacts/{id}/contactGoals
GET /contacts/{id}/contactLogs
operationId: Contact_getLogs

Parameters

Name In Required Type Description
id path required integer

ID of the contact

Responses

200

200
404

404
GET /contacts/{id}/contactLogs
GET /contacts/{id}/organization
operationId: Contact_getOrganization

Parameters

Name In Required Type Description
id path required integer

ID of the contact

Responses

200

200
404

404
GET /contacts/{id}/organization
GET /contacts/{id}/plusAppend
operationId: Contact_getPlusAppend

Parameters

Name In Required Type Description
id path required integer

ID of the contact

Responses

200

200
404

404
GET /contacts/{id}/plusAppend
GET /contacts/{id}/scoreValues
operationId: Contact_getScoreValues

Parameters

Name In Required Type Description
id path required integer

id of the Contact

Responses

200

200
404

404
GET /contacts/{id}/scoreValues
GET /contacts/{id}/trackingLogs
operationId: Contact_getTrackingLogs

Parameters

Name In Required Type Description
id path required integer

ID of the contact

Responses

200

200
404

404
GET /contacts/{id}/trackingLogs
GET /geoIps/{geoAddressID}/geoAddress
operationId: Contact_getGeoIpAddress

Parameters

Name In Required Type Description
geoAddressID path required integer

ID of the contact

Responses

200

200
404

404
GET /geoIps/{geoAddressID}/geoAddress
POST /import/bulk_import
operationId: Contact_bulkImportContacts

Request Body

application/json
schema ContactBulkImportContactsRequest

Responses

200

200
400

400
POST /import/bulk_import

Customer 4 endpoints

POST /ecomCustomers

Create a new e-commerce customer resource.

operationId: Customer_createNewCustomer

Request Body

application/json
schema CustomerCreateNewCustomerRequest

Responses

201

201
400

400
POST /ecomCustomers
DELETE /ecomCustomers/{id}

Delete an existing e-commerce customer resource.

operationId: Customer_deleteCustomerResource

Parameters

Name In Required Type Description
id path required string

The id of the customer to delete.

Responses

200

200
400

400
DELETE /ecomCustomers/{id}
GET /ecomCustomers/{id}

Retrieve an existing e-commerce customer resource.

operationId: Customer_get

Parameters

Name In Required Type Description
id path required string

The id of the customer to retrieve

Responses

200

200
400

400
GET /ecomCustomers/{id}
PUT /ecomCustomers/{id}

Update an existing e-commerce customer resource.

operationId: Customer_updateResource

Parameters

Name In Required Type Description
id path required string

The id of the customer to update

Request Body

application/json
schema CustomerUpdateResourceRequest

Responses

200

200
PUT /ecomCustomers/{id}
Load more endpoints

Schemas

object 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"
        }
      }
    }
  }
}
object 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"
        }
      }
    }
  }
}
object 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"
        }
      }
    }
  }
}
object 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"
        }
      }
    }
  }
}
object 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"
        }
      }
    }
  }
}
object 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"
        }
      }
    }
  }
}
object 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)"
        }
      }
    }
  }
}
object 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"
        }
      }
    }
  }
}
object 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"
        }
      }
    }
  }
}
object 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"
        }
      }
    }
  }
}
object 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"
        }
      }
    }
  }
}
object 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`."
        }
      }
    }
  }
}
object 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"
        }
      }
    }
  }
}
object 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"
        }
      }
    }
  }
}
object 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"
        }
      }
    }
  }
}
object 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"
        }
      }
    }
  }
}
object NoteCreateAccountNoteRequest 
{
  "type": "object",
  "properties": {
    "note": {
      "type": "object",
      "required": [
        "note"
      ],
      "properties": {
        "note": {
          "type": "string",
          "description": "Account note's content"
        }
      }
    }
  }
}
object NoteUpdateNoteRequest 
{
  "type": "object",
  "properties": {
    "note": {
      "type": "object",
      "required": [
        "note"
      ],
      "properties": {
        "note": {
          "type": "string",
          "description": "Account note's content"
        }
      }
    }
  }
}
Load more schemas