ActiveCampaign

Email marketing and CRM automation

developers.activecampaign.com/reference ↗

Version

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

Clear filters

GET POST PUT PATCH DELETE

Account 3 endpoints

DELETE /accountContacts/{id} Delete an association

Delete an existing account association

operationId: Account_deleteAssociation

Parameters

Name	In	Required	Type	Description
id	path	required	integer	Association’s ID

Responses

200

404

DELETE /accountContacts/{id}

DELETE /accounts/bulk_delete Bulk delete accounts

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

400

DELETE /accounts/bulk_delete

DELETE /accounts/{id} Delete an account

Delete an existing account

operationId: Account_deleteById

Parameters

Name	In	Required	Type	Description
id	path	required	integer	Account’s id

Responses

200

400

DELETE /accounts/{id}

Address 1 endpoints

DELETE /addresses/{id} Delete an address

operationId: Address_deleteAddress

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the Address to delete

Responses

200

404

DELETE /addresses/{id}

Calendar 1 endpoints

DELETE /calendars/{id} Delete a calendar feed

operationId: Calendar_deleteFeed

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the calendar feed to delete

Responses

200

DELETE /calendars/{id}

Connection 1 endpoints

DELETE /connections/{id} Delete a connection

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

400

DELETE /connections/{id}

Contact 2 endpoints

DELETE /contactAutomations/{id} Remove a contact from an automation

operationId: Contact_removeFromAutomation

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the contactAutomation to delete

Responses

200

403

DELETE /contactAutomations/{id}

DELETE /contacts/{id} Delete a contact

Delete an existing contact

operationId: Contact_deleteById

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The contact id

Responses

200

404

DELETE /contacts/{id}

Customer 1 endpoints

DELETE /ecomCustomers/{id} Delete a customer

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

400

DELETE /ecomCustomers/{id}

Deal 9 endpoints

DELETE /contactDeals/{id} Delete a secondary contact

Delete an existing secondary contact

operationId: Deal_deleteSecondaryContact

Parameters

Name	In	Required	Type	Description
id	path	required	integer	Secondary Contact’s id

Responses

200

404

DELETE /contactDeals/{id}

DELETE /dealCustomFieldData/{id} Delete a custom field value

operationId: Deal_deleteCustomFieldValue

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the dealCustomFieldData to retrieve

Responses

200

404

DELETE /dealCustomFieldData/{id}

DELETE /dealCustomFieldMeta/{id} Delete a custom field

operationId: Deal_deleteCustomFieldMeta

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the field to delete

Responses

200

404

DELETE /dealCustomFieldMeta/{id}

DELETE /dealGroups/{id} Delete a pipeline

Delete an existing pipeline

operationId: Deal_deletePipeline

Parameters

Name	In	Required	Type	Description
id	path	required	integer	Pipeline’s id

Responses

200

DELETE /dealGroups/{id}

DELETE /dealRoles/{id} Delete a deal role

operationId: Deal_deleteRole

Parameters

Name	In	Required	Type	Description
id	path	required	string	Deal role’s id

Responses

200

400

DELETE /dealRoles/{id}

DELETE /dealStages/{id} Delete a stage

Delete an existing stage

operationId: Deal_deleteStageById

Parameters

Name	In	Required	Type	Description
id	path	required	integer	Deal stage’s id

Responses

200

DELETE /dealStages/{id}

DELETE /dealTasks/{id} Delete a task

Delete an existing task

operationId: Deal_deleteTask

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The task id

Responses

200

400

DELETE /dealTasks/{id}

DELETE /dealTasktypes/{id} Delete a task type

Delete an existing task type

operationId: Deal_deleteTaskType

Parameters

Name	In	Required	Type	Description
id	path	required	integer	Deal task type’s id

Responses

default

403

DELETE /dealTasktypes/{id}

DELETE /deals/{id} Delete a deal

Delete an existing deal

operationId: Deal_removeById

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The Deal’s id

Responses

200

400

DELETE /deals/{id}

Event 1 endpoints

DELETE /eventTrackingEvents/{eventName} Delete event (name only)

Remove an existing event tracking event (name only)

operationId: Event_deleteEventName

Parameters

Name	In	Required	Type	Description
eventName	path	required	string	Name of event to delete. Spaces in names are allowed, but must be encoded (for example, “my%20event”).

Responses

200

400

DELETE /eventTrackingEvents/{eventName}

Field 6 endpoints

DELETE /accountCustomFieldData/{id} Delete a custom field value

operationId: Field_deleteCustomFieldValue

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the dealCustomFieldData to retrieve

Responses

200

404

DELETE /accountCustomFieldData/{id}

DELETE /accountCustomFieldMeta/{id} Delete a custom field

operationId: Field_deleteCustomFieldMeta

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the field to delete

Responses

200

404

DELETE /accountCustomFieldMeta/{id}

DELETE /customObjects/schemas/{schemaId}/fields/{fieldId} Delete a field

Deleting a schema field is an irreversible process.

Assuming a valid 202 Accepted response is received, any associated field data on associated records will immediately be unavailable to the user. There may be a small delay if record requests are in the midst of processing when the field delete request is issued.

The deleted field id will not be immediately recycled for reuse. Users are encouraged to leverage the ?showFields=all query parameter when programmatically creating new schema fields, to ensure field id uniqueness. Fields that have been deleted will contain a status: marked_for_deletion attribute.

The field delete operation is only permitted for admin users.
Field deletion is not permitted on public or child schemas (private schemas only).

operationId: Field_deleteField

Parameters

Name	In	Required	Type	Description
schemaId	path	required	string	Schema ID of the field to be deleted
fieldId	path	required	string	Field ID of the field to be deleted
showFields	query	optional	string	Toggle which fields are shown in the response body of a schema (if there hidden due to e.g. recently being deleted). Omit this parameter entirely to hide fields by default.

Responses

202

DELETE /customObjects/schemas/{schemaId}/fields/{fieldId}

DELETE /fieldValues/{id} Delete a custom field value

operationId: Field_deleteCustomValue

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the fieldValue to delete

Responses

200

403

DELETE /fieldValues/{id}

DELETE /fields/{id} Delete a custom field

operationId: Field_deleteCustomField

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the field option to delete

Responses

200

404

DELETE /fields/{id}

DELETE /groupMembers/{groupID} Delete Custom Field Field Group

operationId: Field_deleteFieldGroup

Parameters

Name	In	Required	Type	Description
groupID	path	required	string	Group ID

Request Body

application/json

schema FieldDeleteFieldGroupRequest

Responses

200

404

DELETE /groupMembers/{groupID}

Group 1 endpoints

DELETE /groups/{id} Delete a group

operationId: Group_deleteGroup

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the group to be deleted

Responses

200

400

DELETE /groups/{id}

List 4 endpoints

DELETE /addressLists/{id} Delete address associated with a specific list

operationId: List_deleteAssociatedAddress

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the AddressList to delete

Responses

200

404

DELETE /addressLists/{id}

DELETE /fieldRels/{fieldRelId} Delete a custom field relationship to list(s)

operationId: List_deleteFieldRelationToList

Parameters

Name	In	Required	Type	Description
fieldRelId	path	required	integer	Field relationship ID to be deleted

Responses

200

403

DELETE /fieldRels/{fieldRelId}

DELETE /lists/{id} Delete a list

operationId: List_deleteById

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the list to delete

Responses

200

403

DELETE /lists/{id}

DELETE /siteTrackingDomains/{name} Remove domain from whitelist

Remove a domain from the site tracking whitelist

operationId: List_removeDomain

Parameters

Name	In	Required	Type	Description
name	path	required	string	The domain name to remove from the whitelist

Responses

204

DELETE /siteTrackingDomains/{name}

Message 1 endpoints

DELETE /messages/{id} Delete a message

operationId: Message_removeById

Parameters

Name	In	Required	Type	Description
id	path	required	string	ID of the message to delete

Responses

200

400

DELETE /messages/{id}

Note 1 endpoints

DELETE /notes/{id} Delete a note

operationId: Note_deleteNoteById

Parameters

Name	In	Required	Type	Description
id	path	required	string	ID of the note to delete

Responses

200

403

DELETE /notes/{id}

Order 1 endpoints

DELETE /ecomOrders/{ecomOrderId} Delete an order

Delete an existing e-commerce order resource.

operationId: Order_deleteOrder

Parameters

Name	In	Required	Type	Description
ecomOrderId	path	required	integer	The id of the order to delete.

Responses

200

DELETE /ecomOrders/{ecomOrderId}

Outcome 2 endpoints

DELETE /taskOutccomes/{id} Delete a task outcome

Delete an existing task outcome

operationId: Outcome_deleteTaskOutcome

Parameters

Name	In	Required	Type	Description
id	path	required	string	Task outcome’s id

Responses

200

404

DELETE /taskOutccomes/{id}

DELETE /tasktypeOutcomeRels/{id} Delete a task type - outcome relation

Delete an existing task type - outcome relation

operationId: Outcome_deleteTaskTypeOutcomeRelation

Parameters

Name	In	Required	Type	Description
id	path	required	integer	Task type - outcome relation’s id

Responses

200

404

DELETE /tasktypeOutcomeRels/{id}

Response 1 endpoints

DELETE /savedResponses/{id} Delete a saved response

operationId: Response_removeById

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the saved response to remove

Responses

200

404

DELETE /savedResponses/{id}

Schema 3 endpoints

DELETE /customObjects/records/{schemaId}/external/{externalId} Delete a record by external ID

operationId: Schema_deleteRecordByExternalId

Parameters

Name	In	Required	Type	Description
schemaId	path	required	string	ID of schema
externalId	path	required	string	External ID of record

Responses

202

400

DELETE /customObjects/records/{schemaId}/external/{externalId}

DELETE /customObjects/records/{schemaId}/{recordId} Delete a record by id

operationId: Schema_deleteRecordById

Parameters

Name	In	Required	Type	Description
schemaId	path	required	string	ID of schema
recordId	path	required	string	ID of record

Responses

202

400

DELETE /customObjects/records/{schemaId}/{recordId}

DELETE /customObjects/schemas/{id} Delete a schema

operationId: Schema_deleteSchemaById

Parameters

Name	In	Required	Type	Description
id	path	required	string	Id of schema to delete

Responses

200

404

DELETE /customObjects/schemas/{id}

Tag 2 endpoints

DELETE /contactTags/{id} Remove a tag from a contact

Delete a contact tag object

operationId: Tag_removeTagFromContact

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The contactTag id

Responses

200

404

DELETE /contactTags/{id}

DELETE /tags/{id} Delete a Tag

operationId: Tag_removeTag

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the tag to remove

Responses

200

404

DELETE /tags/{id}

User 2 endpoints

DELETE /addressGroups/{id} Delete address associated with a specific user group

operationId: User_deleteAddressGroup

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the AddressGroup to delete

Responses

200

404

DELETE /addressGroups/{id}

DELETE /users/{id} Delete a user

Delete an existing user

operationId: User_deleteUser

Parameters

Name	In	Required	Type	Description
id	path	required	integer	ID of the user you wish to delete

Responses

200

400

DELETE /users/{id}

Webhook 1 endpoints

DELETE /webhooks/{id} Delete a webhook

Delete an existing webhook

operationId: Webhook_deleteExisting

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The webhook id

Responses

200

DELETE /webhooks/{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