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

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

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

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

Connection 1 endpoints

POST /connections

Create a new connection resource.

operationId: Connection_createNewResource

Request Body

application/json
schema ConnectionCreateNewResourceRequest

Responses

200

200
POST /connections

Contact 4 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
POST /contacts
operationId: Contact_createNewContact

Request Body

application/json
schema ContactCreateNewContactRequest

Responses

201

201
404

404
422

422
POST /contacts
POST /import/bulk_import
operationId: Contact_bulkImportContacts

Request Body

application/json
schema ContactBulkImportContactsRequest

Responses

200

200
400

400
POST /import/bulk_import

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

Deal 11 endpoints

POST /contactDeals

Create a new secondary contact for a deal

operationId: Deal_createSecondaryContact

Request Body

application/json
schema DealCreateSecondaryContactRequest

Responses

200

200
422

422
POST /contactDeals
POST /dealCustomFieldData
operationId: Deal_createCustomFieldValue

Request Body

application/json
schema DealCreateCustomFieldValueRequest

Responses

200

200
422

422
POST /dealCustomFieldData
POST /dealCustomFieldData/bulkCreate
operationId: Deal_bulkCreateCustomFieldValues

Request Body

application/json
schema DealBulkCreateCustomFieldValuesRequest

Responses

200

200
POST /dealCustomFieldData/bulkCreate
POST /dealCustomFieldMeta
operationId: Deal_createCustomFieldMeta

Request Body

application/json
schema DealCreateCustomFieldMetaRequest

Responses

200

200
422

422
POST /dealCustomFieldMeta
POST /dealGroups

Create a new pipeline

operationId: Deal_createPipeline

Request Body

application/json
schema DealCreatePipelineRequest

Responses

200

200
400

400
POST /dealGroups
POST /dealRoles
operationId: Deal_roleCreation

Request Body

application/json
schema DealRoleCreationRequest

Responses

200

200
400

400
POST /dealRoles
POST /dealStages

Create a new stage for a pipeline

operationId: Deal_createStage

Parameters

Name In Required Type Description
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 DealCreateStageRequest

Responses

200

200
400

400
POST /dealStages
POST /dealTasks

Create a new task

operationId: Deal_createNewTask

Request Body

application/json
schema DealCreateNewTaskRequest

Responses

201

201
400

400
POST /dealTasks
POST /dealTasktypes

Create a new task type

operationId: Deal_createTaskType

Request Body

application/json
schema DealCreateTaskTypeRequest

Responses

200

200
400

400
POST /dealTasktypes
POST /deals

Create a new deal

operationId: Deal_newDealCreation

Request Body

application/json
schema DealNewDealCreationRequest

Responses

201

201
400

400
POST /deals
POST /deals/{id}/notes

Create a new note for a deal

operationId: Deal_createNote

Parameters

Name In Required Type Description
id path required string

The Deal’s id to assign new note to

Request Body

application/json
schema DealCreateNoteRequest

Responses

201

201
POST /deals/{id}/notes

Event 2 endpoints

POST /event

Track an event using event tracking. Event Tracking must be toggled on in your ActiveCampaign account on “Website” -> “Site Tracking” (scroll down to Event tracking) in order for this call to work.

operationId: Event_trackEvent

Request Body

application/json
schema EventTrackEventRequest

Responses

200

200
400

400
POST /event
POST /eventTrackingEvents

Create a new event tracking event (name only)

operationId: Event_createNewEvent

Request Body

application/json
schema EventCreateNewEventRequest

Responses

201

201
POST /eventTrackingEvents

Field 7 endpoints

POST /accountCustomFieldData
operationId: Field_createCustomFieldValue

Request Body

application/json
schema FieldCreateCustomFieldValueRequest
Property Type Required
accountCustomFieldDatum object optional
└ fieldValue string required
└ customFieldId integer required
└ fieldCurrency string optional
└ customerAccountId integer required

Responses

200

200
POST /accountCustomFieldData
POST /accountCustomFieldData/bulkCreate
operationId: Field_bulkCreateCustomAccountFieldValue

Request Body

application/json
schema FieldBulkCreateCustomAccountFieldValueRequest
Property Type Required
array object optional
└ fieldValue string required
└ customFieldId integer required
└ fieldCurrency string optional
└ customerAccountId integer required

Responses

200

200
POST /accountCustomFieldData/bulkCreate
POST /accountCustomFieldMeta
operationId: Field_createCustomFieldMeta

Request Body

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

Responses

200

200
422

422
POST /accountCustomFieldMeta
POST /fieldOption/bulk
operationId: Field_createCustomFieldOptions

Request Body

application/json
schema FieldCreateCustomFieldOptionsRequest

Responses

201

201
422

422
POST /fieldOption/bulk
POST /fieldValues
operationId: Field_createCustomValue

Request Body

application/json
schema FieldCreateCustomValueRequest

Responses

200

200
403

403
POST /fieldValues
POST /fields
operationId: Field_createCustomField

Request Body

application/json
schema FieldCreateCustomFieldRequest

Responses

201

201
403

403
422

422
POST /fields
POST /groupMembers
operationId: Field_addGroupMember

Request Body

application/json
schema FieldAddGroupMemberRequest

Responses

200

200
403

403
404

404
422

422
POST /groupMembers

Group 1 endpoints

POST /groups
operationId: Group_createNewGroup

Request Body

application/json
schema GroupCreateNewGroupRequest

Responses

200

200
POST /groups

List 5 endpoints

POST /contactLists

Subscribe a contact to a list or unsubscribe a contact from a list.

operationId: List_updateListStatusForContact

Request Body

application/json
schema ListUpdateListStatusForContactRequest

Responses

200

200
400

400
POST /contactLists
POST /fieldRels
operationId: List_createFieldRelationshipToLists

Request Body

application/json
schema ListCreateFieldRelationshipToListsRequest

Responses

201

201
403

403
POST /fieldRels
POST /listGroups
operationId: List_groupPermissionCreate

Request Body

application/json
schema ListGroupPermissionCreateRequest

Responses

201

201
403

403
POST /listGroups
POST /lists
operationId: List_createNewList

Request Body

application/json
schema ListCreateNewListRequest

Responses

200

200
400

400
403

403
POST /lists
POST /siteTrackingDomains

Add a domain to the site tracking whitelist

operationId: List_whitelistedDomainCreate

Request Body

application/json
schema ListWhitelistedDomainCreateRequest

Responses

200

200
400

400
POST /siteTrackingDomains

Message 1 endpoints

POST /messages
operationId: Message_createNewMessage

Request Body

application/json
schema MessageCreateNewMessageRequest
Property Type Required
message object optional
└ email string required
└ reply2 string required
└ subject string optional
└ fromname string required
└ preheader_text string optional

Responses

201

201
400

400
POST /messages

Note 2 endpoints

POST /accounts/{id}/notes

Create a new note for an account

operationId: Note_createAccountNote

Parameters

Name In Required Type Description
id path required string

Account’s id to assign new note to

Request Body

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

Responses

201

201
POST /accounts/{id}/notes
POST /notes
operationId: Note_createNew

Request Body

application/json
schema NoteCreateNewRequest

Responses

201

201
400

400
POST /notes

Order 1 endpoints

POST /ecomOrders

Create a new e-commerce order resource.

operationId: Order_createNewOrder

Request Body

application/json
schema OrderCreateNewOrderRequest

Responses

201

201
POST /ecomOrders

Outcome 1 endpoints

POST /taskOutcomes

Create a new task outcome

operationId: Outcome_createTaskOutcome

Request Body

application/json
schema OutcomeCreateTaskOutcomeRequest

Responses

200

200
422

422
POST /taskOutcomes

Reminder 1 endpoints

POST /taskNotifications

Create a new task outcome

operationId: Reminder_createTaskOutcome

Request Body

application/json
schema ReminderCreateTaskOutcomeRequest

Responses

200

200
422

422
POST /taskNotifications

Response 1 endpoints

POST /savedResponses
operationId: Response_createSavedResponse

Request Body

application/json
schema ResponseCreateSavedResponseRequest

Responses

201

201
422

422
POST /savedResponses

Schema 4 endpoints

POST /customObjects/records/{schemaId}
operationId: Schema_createOrUpdateRecord

Parameters

Name In Required Type Description
schemaId path required string

ID of schema

Request Body

application/json
schema SchemaCreateOrUpdateRecordRequest

Responses

201

201
400

400
422

422
POST /customObjects/records/{schemaId}
POST /customObjects/schemas
operationId: Schema_createNew

Request Body

application/json
schema SchemaCreateNewRequest

Responses

201

201
422

422
POST /customObjects/schemas
POST /customObjects/schemas/public
operationId: Schema_createPublicSchema

Request Body

application/json
schema SchemaCreatePublicSchemaRequest

Responses

200

200
400

400
POST /customObjects/schemas/public
POST /customObjects/schemas/{id}/child
operationId: Schema_createChildSchema

Parameters

Name In Required Type Description
id path required string

Id of the parent schema the new child schema will extend

Responses

200

200
400

400
POST /customObjects/schemas/{id}/child

Tag 2 endpoints

POST /contactTags

Create a contact tag object

operationId: Tag_addContactTag

Request Body

application/json
schema TagAddContactTagRequest

Responses

201

201
404

404
422

422
POST /contactTags
POST /tags
operationId: Tag_createTag

Request Body

application/json
schema TagCreateTagRequest

Responses

201

201
POST /tags

User 1 endpoints

POST /users

Create a new user

operationId: User_createNewUser

Request Body

application/json
schema UserCreateNewUserRequest

Responses

201

201
400

400
POST /users

Webhook 1 endpoints

POST /webhooks

Create a new webhook

operationId: Webhook_createNewWebhook

Request Body

application/json
schema WebhookCreateNewWebhookRequest

Responses

201

201
POST /webhooks
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