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

Clear filters
GET POST PUT PATCH DELETE

Account 2 endpoints

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}
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}

Address 1 endpoints

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 1 endpoints

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 1 endpoints

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}

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 1 endpoints

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 1 endpoints

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}

Customer 1 endpoints

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}

Deal 11 endpoints

PUT /contactDeals/{id}

Update an existing secondary contact

operationId: Deal_updateSecondaryContact

Parameters

Name In Required Type Description
id path required integer

Secondary Contact’s id

Request Body

application/json
schema DealUpdateSecondaryContactRequest

Responses

200

200
404

404
422

422
PUT /contactDeals/{id}
PUT /dealCustomFieldData/{id}
operationId: Deal_updateCustomFieldValue

Parameters

Name In Required Type Description
id path required integer

ID of the custom fields value to update

Request Body

application/json
schema DealUpdateCustomFieldValueRequest

Responses

200

200
404

404
422

422
PUT /dealCustomFieldData/{id}
PUT /dealCustomFieldMeta/{id}
operationId: Deal_updateCustomFieldMeta

Parameters

Name In Required Type Description
id path required integer

ID of the custom field to update

Request Body

application/json
schema DealUpdateCustomFieldMetaRequest

Responses

200

200
404

404
PUT /dealCustomFieldMeta/{id}
PUT /dealGroups/{id}

Update an existing pipeline

operationId: Deal_updatePipeline

Parameters

Name In Required Type Description
id path required integer

Pipeline’s id

Request Body

application/json
schema DealUpdatePipelineRequest

Responses

200

200
400

400
PUT /dealGroups/{id}
PUT /dealStages/{id}

Update an existing stage

operationId: Deal_updateStage

Parameters

Name In Required Type Description
id path required integer

Deal stage’s id
reorder query optional integer

Whether to reorder stages within the pipeline after creating a new deal stage. Can be one of 0 and 1. If set to 1, new order values will be assigned to all stages within the same pipeline. If deal stages with the same order exists, the stage with the highest id will be assigned with the lowest order

Request Body

application/json
schema DealUpdateStageRequest

Responses

200

200
400

400
PUT /dealStages/{id}
PUT /dealStages/{id}/deals

Move all deals in one stage to another stage

operationId: Deal_moveDealsToAnotherStage

Parameters

Name In Required Type Description
id path required integer

Deal stage’s id whose deals are to be moved to another deal stage

Request Body

application/json
schema DealMoveDealsToAnotherStageRequest

Responses

200

200
422

422
PUT /dealStages/{id}/deals
PUT /dealTasks/{id}

Update an existing task

operationId: Deal_updateTaskById

Parameters

Name In Required Type Description
id path required integer

The ID of the task

Request Body

application/json
schema DealUpdateTaskByIdRequest

Responses

201

201
400

400
PUT /dealTasks/{id}
PUT /dealTasktypes/{id}

Update an existing task type

operationId: Deal_updateTaskType

Parameters

Name In Required Type Description
id path required integer

Deal task type’s id

Request Body

application/json
schema DealUpdateTaskTypeRequest

Responses

200

200
400

400
PUT /dealTasktypes/{id}
PUT /dealTasktypes/{id}/dealTasks

Move tasks to a different task type

operationId: Deal_moveTasksToAnotherTaskType

Parameters

Name In Required Type Description
id path required integer

Deal task type’s id

Request Body

application/json
schema DealMoveTasksToAnotherTaskTypeRequest

Responses

200

200
400

400
PUT /dealTasktypes/{id}/dealTasks
PUT /deals/{id}

Update an existing deal

operationId: Deal_updateExistingDeal

Parameters

Name In Required Type Description
id path required integer

The Deal’s id

Request Body

application/json
schema DealUpdateExistingDealRequest

Responses

200

200
400

400
PUT /deals/{id}
PUT /deals/{id}/notes/{noteId}

Update an existing note for a deal

operationId: Deal_updateNote

Parameters

Name In Required Type Description
id path required string

Deal’s id to assign new note to
noteId path required string

Deal note’s id to update

Request Body

application/json
schema DealUpdateNoteRequest

Responses

200

200
PUT /deals/{id}/notes/{noteId}

Event 1 endpoints

PUT /eventTracking

Enable or disable event tracking

operationId: Event_toggleStatus

Request Body

application/json
schema EventToggleStatusRequest

Responses

200

200
400

400
PUT /eventTracking

Field 5 endpoints

PUT /accountCustomFieldData/{id}
operationId: Field_updateCustomFieldValue

Parameters

Name In Required Type Description
id path required integer

ID of the custom fields value to update

Request Body

application/json
schema FieldUpdateCustomFieldValueRequest
Property Type Required
accountCustomFieldDatum object optional
└ fieldValue string optional
└ fieldCurrency string optional

Responses

200

200
404

404
PUT /accountCustomFieldData/{id}
PUT /accountCustomFieldMeta/{id}
operationId: Field_updateCustomFieldMeta

Parameters

Name In Required Type Description
id path required integer

ID of the custom field to update

Request Body

application/json
schema FieldUpdateCustomFieldMetaRequest
Property Type Required
accountCustomFieldMetum object optional
└ fieldLabel string optional
└ displayOrder integer optional
└ fieldDefault string optional
└ fieldOptions array optional
└ isFormVisible boolean optional

Responses

200

200
404

404
PUT /accountCustomFieldMeta/{id}
PUT /fieldValues/{id}
operationId: Field_updateCustomValue

Parameters

Name In Required Type Description
id path required string

ID of the fieldValue to update

Request Body

application/json
schema FieldUpdateCustomValueRequest

Responses

200

200
400

400
PUT /fieldValues/{id}
PUT /fields/{id}
operationId: Field_updateCustomField

Parameters

Name In Required Type Description
id path required integer

ID of the field to update

Request Body

application/json
schema FieldUpdateCustomFieldRequest

Responses

200

200
403

403
PUT /fields/{id}
PUT /groupMembers/{groupId}
operationId: Field_updateCustomFieldGroup

Parameters

Name In Required Type Description
groupId path required string

Field group ID (see notes)

Request Body

application/json
schema FieldUpdateCustomFieldGroupRequest

Responses

200

200
403

403
404

404
422

422
PUT /groupMembers/{groupId}

Group 1 endpoints

PUT /groups/{id}
operationId: Group_updateGroupById

Parameters

Name In Required Type Description
id path required integer

ID of the group to update

Request Body

application/json
schema GroupUpdateGroupByIdRequest

Responses

200

200
403

403
PUT /groups/{id}

Message 1 endpoints

PUT /messages/{id}
operationId: Message_updateById

Parameters

Name In Required Type Description
id path required string

ID of the message to update
message.fromname header optional string

Name of sender
message.email header optional string

Email of sender
message.reply2 header optional string

Reply email for the recipient to reply to
message.subject header optional string

Subject of message
message.preheader_text header optional string

Preheader Text

Request Body

application/json
schema MessageUpdateByIdRequest

Responses

200

200
404

404
PUT /messages/{id}

Note 2 endpoints

PUT /accounts/{id}/notes/{noteid}

Update an existing note for a account

operationId: Note_updateNote

Parameters

Name In Required Type Description
id path required string

Account’s id to assign new note to
noteid path required string

Account note’s id to update

Request Body

application/json
schema NoteUpdateNoteRequest
Property Type Required
note object optional
└ note string required

Responses

200

200
PUT /accounts/{id}/notes/{noteid}
PUT /notes/{id}
operationId: Note_updateNoteById

Parameters

Name In Required Type Description
id path required string

ID of the note to update

Request Body

application/json
schema NoteUpdateNoteByIdRequest

Responses

200

200
403

403
PUT /notes/{id}

Order 1 endpoints

PUT /ecomOrders/{id}

Update an existing ecommerce order/cart resource.

operationId: Order_updateOrderResource

Parameters

Name In Required Type Description
id path required string

The ID of the order to update

Request Body

application/json
schema OrderUpdateOrderResourceRequest

Responses

200

200
PUT /ecomOrders/{id}

Outcome 1 endpoints

PUT /taskOutccomes/{id}

Update an existing task outcome

operationId: Outcome_updateTaskOutcome

Parameters

Name In Required Type Description
id path required integer

Task outcome’s id

Request Body

application/json
schema OutcomeUpdateTaskOutcomeRequest

Responses

200

200
422

422
PUT /taskOutccomes/{id}

Response 1 endpoints

PUT /savedResponses/{id}
operationId: Response_updateSavedResponse

Parameters

Name In Required Type Description
id path required integer

ID of the saved response to update

Request Body

application/json
schema ResponseUpdateSavedResponseRequest

Responses

200

200
422

422
PUT /savedResponses/{id}

Schema 1 endpoints

PUT /customObjects/schemas/{schemaId}

Make an update to a given schema.

To delete a schema field, reference the field delete endpoint: https://developers.activecampaign.com/reference/delete-a-field-1

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.

operationId: Schema_updateSchema

Parameters

Name In Required Type Description
schemaId path required string

Id of Schema being updated
validateOnly header optional boolean

When set to true the API will validate the schema update without saving changes
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.

Request Body

application/json
schema SchemaUpdateSchemaRequest

Responses

200

200
404

404
422

422
PUT /customObjects/schemas/{schemaId}

Tag 1 endpoints

PUT /tags/{id}
operationId: Tag_updateTag

Parameters

Name In Required Type Description
id path required integer

ID of the tag to update

Request Body

application/json
schema TagUpdateTagRequest

Responses

200

200
PUT /tags/{id}

Tracking 1 endpoints

PUT /siteTracking

Enable or disable site tracking

operationId: Tracking_enableDisableSite

Request Body

application/json
schema TrackingEnableDisableSiteRequest

Responses

200

200
400

400
PUT /siteTracking

User 1 endpoints

PUT /users/{id}

Update an existing user

operationId: User_updateExistingUser

Parameters

Name In Required Type Description
id path required integer

ID of the user

Request Body

application/json
schema UserUpdateExistingUserRequest

Responses

200

200
400

400
PUT /users/{id}

Webhook 1 endpoints

PUT /webhooks/{id}

Update an existing webhook

operationId: Webhook_updateExisting

Parameters

Name In Required Type Description
id path required integer

The webhook id

Request Body

application/json
schema WebhookUpdateExistingRequest

Responses

200

200
400

400
PUT /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