Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://{youraccountname}.api-us1.com/api/3
/accountContacts
Create a new account association
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountCreateAssociationRequest"
},
"examples": {
"Request Example": {
"value": {
"accountContact": {
"account": 1,
"contact": 2,
"jobTitle": "Product Manager"
}
}
}
}
}
}
}
201
422
POST /accountContacts
/accounts
Create a new account
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountCreateNewAccountRequest"
},
"examples": {
"Request Example": {
"value": {
"account": {
"name": "Example Account",
"owner": 1,
"fields": [
{
"fieldValue": "500-1000",
"customFieldId": 9
},
{
"fieldValue": 1234,
"customFieldId": 20,
"fieldCurrency": "GBP"
}
],
"accountUrl": "https://www.example.com"
}
}
}
}
}
}
}
201
422
POST /accounts
/addresses
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressCreateNewAddressRequest"
},
"examples": {
"Request Example": {
"value": {
"address": {
"country": "US",
"address_1": "TEST ADDRESS",
"company_name": "TEST NAME"
}
}
}
}
}
}
}
200
400
POST /addresses
/calendars
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CalendarCreateFeedRequest"
},
"examples": {
"Request Example": {
"value": {
"calendar": {
"type": "All",
"title": "Calendar Title",
"notification": 1
}
}
}
}
}
}
}
200
POST /calendars
/connections
Create a new connection resource.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionCreateNewResourceRequest"
},
"examples": {
"JSON": {
"value": {
"connection": {
"name": "Toystore, Inc.",
"linkUrl": "http://example.com/foo/",
"logoUrl": "http://example.com/i/foo.png",
"service": "fooCommerce",
"externalid": "toystore123"
}
}
}
}
}
}
}
200
POST /connections
/contact/sync
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactSyncDataRequest"
},
"examples": {
"Request Example": {
"value": {
"contact": {
"email": "jondoe@example.com",
"phone": "7223224241",
"lastName": "Doe",
"firstName": "John",
"fieldValues": [
{
"field": "1",
"value": "The Value for First Field"
},
{
"field": "6",
"value": "2008-01-20"
}
]
}
}
}
}
}
}
}
201
400
POST /contact/sync
/contactAutomations
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactAddToAutomationRequest"
},
"examples": {
"Request Example": {
"value": {
"contactAutomation": {
"contact": "117",
"automation": "42"
}
}
}
}
}
}
}
201
403
POST /contactAutomations
/contacts
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactCreateNewContactRequest"
},
"examples": {
"Request Example": {
"value": {
"contact": {
"email": "johndoe@example.com",
"phone": "7223224241",
"lastName": "Doe",
"firstName": "John",
"fieldValues": [
{
"field": "1",
"value": "The Value for First Field"
},
{
"field": "6",
"value": "2008-01-20"
}
]
}
}
}
}
}
}
}
201
404
422
POST /contacts
/import/bulk_import
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactBulkImportContactsRequest"
},
"examples": {
"Request Example": {
"value": {
"callback": {
"url": "www.your_web_server.com",
"params": [
{
"key": "",
"value": ""
}
],
"headers": [
{
"key": "",
"value": ""
}
],
"requestType": "POST",
"detailed_results": "true"
},
"contacts": [
{
"tags": [
"dictumst",
"aliquam",
"augue quam",
"sollicitudin rutrum"
],
"email": "someone@somewhere.com",
"phone": "123-456-7890",
"fields": [
{
"id": 1,
"value": "foo"
},
{
"id": 2,
"value": "||foo||bar||baz||"
}
],
"last_name": "Doe",
"subscribe": [
{
"listid": 1
},
{
"listid": 2
}
],
"first_name": "Jane",
"unsubscribe": [
{
"listid": 3
}
],
"customer_acct_name": "ActiveCampaign",
"exclude_automations": false
}
]
}
}
}
}
}
}
200
400
POST /import/bulk_import
/ecomCustomers
Create a new e-commerce customer resource.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerCreateNewCustomerRequest"
},
"examples": {
"JSON": {
"value": {
"ecomCustomer": {
"email": "alice@example.com",
"externalid": "56789",
"connectionid": "1",
"acceptsMarketing": "1"
}
}
}
}
}
}
}
201
400
POST /ecomCustomers
/contactDeals
Create a new secondary contact for a deal
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealCreateSecondaryContactRequest"
},
"examples": {
"Request Example": {
"value": {
"contactDeal": {
"deal": 2,
"contact": 1
}
}
}
}
}
}
}
200
422
POST /contactDeals
/dealCustomFieldData
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealCreateCustomFieldValueRequest"
},
"examples": {
"date": {
"value": {
"dealCustomFieldDatum": {
"dealId": "1",
"fieldValue": "2018-12-31",
"customFieldId": "6"
}
}
},
"number": {
"value": {
"dealCustomFieldDatum": {
"dealId": "1",
"fieldValue": "100.99",
"customFieldId": "5"
}
}
},
"currency": {
"value": {
"dealCustomFieldDatum": {
"dealId": "1",
"fieldValue": 9999,
"customFieldId": "4",
"fieldCurrency": "cad"
}
}
},
"datetime": {
"value": {
"dealCustomFieldDatum": {
"dealId": "1",
"fieldValue": "2020-05-19T02:45:00-05:00",
"customFieldId": "6"
}
}
},
"dropdown/radio": {
"value": {
"dealCustomFieldDatum": {
"dealId": "2",
"fieldValue": "||option 1||option 2||option 3||",
"customFieldId": "2"
}
}
},
"text/textarea/hidden": {
"value": {
"dealCustomFieldDatum": {
"dealId": "2",
"fieldValue": "test title",
"customFieldId": "1"
}
}
},
"multiselect/checkbox (single)": {
"value": {
"dealCustomFieldDatum": {
"dealId": "2",
"fieldValue": [
"option 1"
],
"customFieldId": "3"
}
}
},
"multiselect/checkbox (multiple)": {
"value": {
"dealCustomFieldDatum": {
"dealId": "2",
"fieldValue": [
"option 1",
"option 3",
"option 4"
],
"customFieldId": "3"
}
}
}
}
}
}
}
200
422
POST /dealCustomFieldData
/dealCustomFieldData/bulkCreate
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealBulkCreateCustomFieldValuesRequest"
},
"examples": {
"Request Example": {
"value": [
{
"dealId": "1",
"fieldValue": "test title",
"customFieldId": "1"
},
{
"dealId": "1",
"fieldValue": "test title",
"customFieldId": "2"
},
{
"dealId": "1",
"fieldValue": [
"option 1",
"option 3",
"option 4"
],
"customFieldId": "3"
},
{
"dealId": "1",
"fieldValue": 9999,
"customFieldId": "4",
"fieldCurrency": "cad"
},
{
"dealId": "1",
"fieldValue": "100.99",
"customFieldId": "5"
},
{
"dealId": "1",
"fieldValue": "2018-12-31",
"customFieldId": "6"
},
{
"dealId": "1",
"fieldValue": "2020-05-19T02:45:00-05:00",
"customFieldId": "7"
}
]
}
}
}
}
}
200
POST /dealCustomFieldData/bulkCreate
/dealCustomFieldMeta
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealCreateCustomFieldMetaRequest"
},
"examples": {
"date": {
"value": {
"dealCustomFieldMetum": {
"fieldType": "date",
"fieldLabel": "sample date field",
"isRequired": 1,
"displayOrder": 3,
"fieldDefault": "2018-12-31 00:00:00",
"isFormVisible": 1
}
}
},
"text": {
"value": {
"dealCustomFieldMetum": {
"fieldType": "text",
"fieldLabel": "sample text field2",
"displayOrder": 1,
"fieldDefault": "Default Text",
"isFormVisible": 1
}
}
},
"radio": {
"value": {
"dealCustomFieldMetum": {
"fieldType": "radio",
"fieldLabel": "sample radio field",
"isRequired": 1,
"displayOrder": 6,
"fieldDefault": "option 2",
"fieldOptions": [
"option 1",
"option 2",
"option 3"
],
"isFormVisible": 1
}
}
},
"hidden": {
"value": {
"dealCustomFieldMetum": {
"fieldType": "hidden",
"fieldLabel": "sample hidden field",
"isRequired": 1,
"displayOrder": 8,
"fieldDefault": "Default Text in Hidden Field",
"isFormVisible": 1
}
}
},
"number": {
"value": {
"dealCustomFieldMetum": {
"fieldType": "number",
"fieldLabel": "sample number field",
"isRequired": 1,
"displayOrder": 9,
"fieldDefault": "100.99",
"isFormVisible": 1
}
}
},
"checkbox": {
"value": {
"dealCustomFieldMetum": {
"fieldType": "checkbox",
"fieldLabel": "sample checkbox field",
"isRequired": 1,
"displayOrder": 7,
"fieldDefault": [
"option 2",
"option 3"
],
"fieldOptions": [
"option 1",
"option 2",
"option 3"
],
"isFormVisible": 1
}
}
},
"currency": {
"value": {
"dealCustomFieldMetum": {
"fieldType": "currency",
"fieldLabel": "sample money field",
"isRequired": 1,
"displayOrder": 10,
"fieldDefault": "10099",
"isFormVisible": 1,
"fieldDefaultCurrency": "aud"
}
}
},
"dropdown": {
"value": {
"dealCustomFieldMetum": {
"fieldType": "dropdown",
"fieldLabel": "sample dropdown field",
"isRequired": 1,
"displayOrder": 4,
"fieldDefault": "option 2",
"fieldOptions": [
"option 1",
"option 2",
"option 3"
],
"isFormVisible": 1
}
}
},
"textarea": {
"value": {
"dealCustomFieldMetum": {
"fieldType": "textarea",
"fieldLabel": "sample textarea field",
"isRequired": 1,
"displayOrder": 2,
"fieldDefault": "Default Text in Text Area",
"isFormVisible": 1
}
}
},
"multiselect": {
"value": {
"dealCustomFieldMetum": {
"fieldType": "multiselect",
"fieldLabel": "sample multiselect field",
"isRequired": 1,
"displayOrder": 5,
"fieldDefault": [
"option 2",
"option 3"
],
"fieldOptions": [
"option 1",
"option 2",
"option 3"
],
"isFormVisible": 1
}
}
},
"datetime (ISO)": {
"value": {
"dealCustomFieldMetum": {
"fieldType": "datetime",
"fieldLabel": "sample datetime field",
"isRequired": 1,
"displayOrder": 3,
"fieldDefault": "2020-05-16T03:15:00-05:00",
"isFormVisible": 1
}
}
}
}
}
}
}
200
422
POST /dealCustomFieldMeta
/dealGroups
Create a new pipeline
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealCreatePipelineRequest"
},
"examples": {
"Request Example": {
"value": {
"dealGroup": {
"title": "Qualifications",
"users": [
"3",
"4"
],
"allusers": 0,
"currency": "eur",
"allgroups": 1,
"autoassign": 1
}
}
}
}
}
}
}
200
400
POST /dealGroups
/dealRoles
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealRoleCreationRequest"
}
}
}
}
200
400
POST /dealRoles
/dealStages
Create a new stage for a pipeline
| 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 |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealCreateStageRequest"
},
"examples": {
"Request Example": {
"value": {
"dealStage": {
"color": "32B0FC",
"group": "4",
"order": 1,
"title": "Initial Contact",
"width": 360,
"dealOrder": "next-action DESC",
"cardRegion1": "title",
"cardRegion2": "next-action",
"cardRegion3": "show-avatar",
"cardRegion4": "contact-fullname-orgname",
"cardRegion5": "value"
}
}
}
}
}
}
}
200
400
POST /dealStages
/dealTasks
Create a new task
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealCreateNewTaskRequest"
},
"examples": {
"Request Example": {
"value": {
"dealTask": {
"note": "Testing Task",
"edate": "2017-02-25T12:15:00-06:00",
"relid": "7",
"title": null,
"status": 0,
"duedate": "2017-02-25T12:00:00-06:00",
"assignee": 2,
"ownerType": "contact",
"dealTasktype": "1",
"doneAutomation": 101,
"triggerAutomationOnCreate": 100
}
}
}
}
}
}
}
201
400
POST /dealTasks
/dealTasktypes
Create a new task type
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealCreateTaskTypeRequest"
},
"examples": {
"Request Example": {
"value": {
"dealTasktype": {
"title": "Skype",
"status": 0
}
}
}
}
}
}
}
200
400
POST /dealTasktypes
/deals
Create a new deal
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealNewDealCreationRequest"
},
"examples": {
"POST /deals (Example REQUEST)": {
"value": {
"deal": {
"group": "1",
"owner": "1",
"stage": "1",
"title": "AC Deal",
"value": 45600,
"fields": [
{
"fieldValue": "First field value",
"customFieldId": 1
},
{
"fieldValue": "2008-01-20",
"customFieldId": 2
},
{
"fieldValue": 5500,
"customFieldId": 3,
"fieldCurrency": "EUR"
}
],
"status": 0,
"account": "45",
"contact": "51",
"percent": null,
"currency": "usd",
"description": "This deal is an important deal"
}
}
}
}
}
}
}
201
400
POST /deals
/deals/{id}/notes
Create a new note for a deal
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | The Deal’s id to assign new note to |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealCreateNoteRequest"
},
"examples": {
"Request Example": {
"value": {
"note": {
"note": "Note for the deal"
}
}
}
}
}
}
}
201
POST /deals/{id}/notes
/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.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventTrackEventRequest"
}
}
}
}
200
400
POST /event
/eventTrackingEvents
Create a new event tracking event (name only)
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventCreateNewEventRequest"
},
"examples": {
"JSON": {
"value": {
"eventTrackingEvent": {
"name": "my new fab event"
}
}
}
}
}
}
}
201
POST /eventTrackingEvents
/accountCustomFieldData
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FieldCreateCustomFieldValueRequest"
},
"examples": {
"date": {
"value": {
"accountCustomFieldDatum": {
"fieldValue": "2018-12-31",
"customFieldId": "6",
"customerAccountId": "1"
}
}
},
"number": {
"value": {
"accountCustomFieldDatum": {
"fieldValue": "100.99",
"customFieldId": "5",
"customerAccountId": "1"
}
}
},
"currency": {
"value": {
"accountCustomFieldDatum": {
"fieldValue": 9999,
"customFieldId": "4",
"fieldCurrency": "cad",
"customerAccountId": "1"
}
}
},
"datetime": {
"value": {
"accountCustomFieldDatum": {
"fieldValue": "2020-05-19T02:45:00-05:00",
"customFieldId": "14",
"customerAccountId": "1"
}
}
},
"dropdown/radio": {
"value": {
"accountCustomFieldDatum": {
"fieldValue": "||option 1||option 2||option 3||",
"customFieldId": "2",
"customerAccountId": "2"
}
}
},
"text/textarea/hidden": {
"value": {
"accountCustomFieldDatum": {
"accountId": "2",
"fieldValue": "test title",
"customFieldId": "1"
}
}
},
"single multiselect/checkbox": {
"value": {
"accountCustomFieldDatum": {
"fieldValue": [
"option 1",
"option 2",
"option 3"
],
"customFieldId": "3",
"customerAccountId": "2"
}
}
},
"mutliple multiselects/checkboxes": {
"value": {
"accountCustomFieldDatum": {
"fieldValue": [
"option 1",
"option 3",
"option 4"
],
"customFieldId": "3",
"customerAccountId": "2"
}
}
}
}
}
}
}
200
POST /accountCustomFieldData
/accountCustomFieldData/bulkCreate
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FieldBulkCreateCustomAccountFieldValueRequest"
},
"examples": {
"Request Example": {
"value": [
{
"accountId": "1",
"fieldValue": "test title",
"customFieldId": "1"
},
{
"accountId": "1",
"fieldValue": "test title",
"customFieldId": "2"
},
{
"accountId": "1",
"fieldValue": [
"option 1",
"option 3",
"option 4"
],
"customFieldId": "3"
},
{
"accountId": "1",
"fieldValue": 9999,
"customFieldId": "4",
"fieldCurrency": "cad"
},
{
"accountId": "1",
"fieldValue": "100.99",
"customFieldId": "5"
},
{
"accountId": "1",
"fieldValue": "2018-12-31",
"customFieldId": "6"
},
{
"accountId": "1",
"fieldValue": "2020-05-19T02:45:00-05:00",
"customFieldId": "7"
}
]
}
}
}
}
}
200
POST /accountCustomFieldData/bulkCreate
/accountCustomFieldMeta
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FieldCreateCustomFieldMetaRequest"
},
"examples": {
"text": {
"value": {
"accountCustomFieldMetum": {
"fieldType": "text",
"fieldLabel": "sample text field2",
"displayOrder": 1,
"fieldDefault": "Default Text",
"isFormVisible": 1
}
}
},
"radio": {
"value": {
"accountCustomFieldMetum": {
"fieldType": "radio",
"fieldLabel": "sample radio field",
"displayOrder": 6,
"fieldDefault": "option 2",
"fieldOptions": [
"option 1",
"option 2",
"option 3"
],
"isFormVisible": 1
}
}
},
"hidden": {
"value": {
"accountCustomFieldMetum": {
"fieldType": "hidden",
"fieldLabel": "sample hidden field",
"displayOrder": 8,
"fieldDefault": "Default Text in Hidden Field",
"isFormVisible": 1
}
}
},
"number": {
"value": {
"accountCustomFieldMetum": {
"fieldType": "number",
"fieldLabel": "sample number field",
"displayOrder": 9,
"fieldDefault": "100.99",
"isFormVisible": 1
}
}
},
"checkbox": {
"value": {
"accountCustomFieldMetum": {
"fieldType": "checkbox",
"fieldLabel": "sample checkbox field",
"displayOrder": 7,
"fieldDefault": [
"option 2",
"option 3"
],
"fieldOptions": [
"option 1",
"option 2",
"option 3"
],
"isFormVisible": 1
}
}
},
"currency": {
"value": {
"accountCustomFieldMetum": {
"fieldType": "currency",
"fieldLabel": "sample money field",
"displayOrder": 10,
"fieldDefault": "10099",
"isFormVisible": 1,
"fieldDefaultCurrency": "aud"
}
}
},
"datetime": {
"value": {
"accountCustomFieldMetum": {
"fieldType": "datetime",
"fieldLabel": "sample datetime field",
"displayOrder": 3,
"fieldDefault": "2020-05-16T03:15:00-05:00",
"isFormVisible": 1
}
}
},
"dropdown": {
"value": {
"accountCustomFieldMetum": {
"fieldType": "dropdown",
"fieldLabel": "sample dropdown field",
"displayOrder": 4,
"fieldDefault": "option 2",
"fieldOptions": [
"option 1",
"option 2",
"option 3"
],
"isFormVisible": 1
}
}
},
"textarea": {
"value": {
"accountCustomFieldMetum": {
"fieldType": "textarea",
"fieldLabel": "sample textarea field",
"displayOrder": 2,
"fieldDefault": "Default Text in Text Area",
"isFormVisible": 1
}
}
},
"multiselect": {
"value": {
"accountCustomFieldMetum": {
"fieldType": "multiselect",
"fieldLabel": "sample multiselect field",
"displayOrder": 5,
"fieldDefault": [
"option 2",
"option 3"
],
"fieldOptions": [
"option 1",
"option 2",
"option 3"
],
"isFormVisible": 1
}
}
},
"date (ISO ONLY)": {
"value": {
"accountCustomFieldMetum": {
"fieldType": "date",
"fieldLabel": "sample date field",
"displayOrder": 3,
"fieldDefault": "2018-12-31 00:00:00",
"isFormVisible": 1
}
}
}
}
}
}
}
200
422
POST /accountCustomFieldMeta
/fieldOption/bulk
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FieldCreateCustomFieldOptionsRequest"
},
"examples": {
"Request Example": {
"value": {
"fieldOptions": [
{
"field": "62",
"label": "Option X",
"value": "X",
"orderid": 1,
"isdefault": false
},
{
"field": "62",
"label": "Option Y",
"value": "Y",
"orderid": 2,
"isdefault": false
},
{
"field": "62",
"label": "Option Z",
"value": "Z",
"orderid": 3,
"isdefault": false
}
]
}
}
}
}
}
}
201
422
POST /fieldOption/bulk
/fieldValues
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FieldCreateCustomValueRequest"
},
"examples": {
"date value": {
"value": {
"fieldValue": {
"field": 7,
"value": "2018-12-31",
"contact": 2
}
}
},
"dropdown/radio value": {
"value": {
"fieldValue": {
"field": 4,
"value": "||option 1||option 2||option 3||",
"contact": 2
}
}
},
"datetime value ISO format": {
"value": {
"fieldValue": {
"field": 7,
"value": "2020-05-19T02:45:00-05:00",
"contact": 2
}
}
},
"text/textarea/hidden value": {
"value": {
"fieldValue": {
"field": 3,
"value": "Blue",
"contact": 2
},
"useDefaults": true
}
},
"multiselect with single option": {
"value": {
"fieldValue": {
"field": 6,
"value": "||Option 2||",
"contact": 2
}
}
},
"multiselect with multiple options": {
"value": {
"fieldValue": {
"field": 6,
"value": "||Option 1||Option 3||Option 4||",
"contact": 2
}
}
}
}
}
}
}
200
403
POST /fieldValues
/fields
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FieldCreateCustomFieldRequest"
},
"examples": {
"date": {
"value": {
"field": {
"type": "date",
"title": "Field Title",
"defval": "2019-01-01",
"perstag": "Personalized Tag",
"visible": 1,
"descript": "Field description",
"ordernum": 1,
"isrequired": 1
}
}
},
"text": {
"value": {
"field": {
"type": "text",
"title": "Field Title",
"defval": "Defaut Value",
"perstag": "Personalized Tag",
"visible": 1,
"descript": "Field description",
"ordernum": 1,
"isrequired": 1
}
}
},
"radio": {
"value": {
"field": {
"type": "radio",
"title": "Field Title",
"perstag": "Personalized Tag",
"visible": 1,
"descript": "Field description",
"ordernum": 1,
"isrequired": 1
}
}
},
"hidden": {
"value": {
"field": {
"type": "hidden",
"title": "Field Title",
"defval": "Defaut Value",
"perstag": "Personalized Tag",
"visible": 1,
"descript": "Field description",
"ordernum": 1,
"isrequired": 1
}
}
},
"checkbox": {
"value": {
"field": {
"type": "checkbox",
"title": "Field Title",
"perstag": "Personalized Tag",
"visible": 1,
"descript": "Field description",
"ordernum": 1,
"isrequired": 1
}
}
},
"datetime": {
"value": {
"field": {
"type": "datetime",
"title": "Field Title",
"defval": "2020-05-19T02:45:00-05:00",
"perstag": "Personalized Tag",
"visible": 1,
"descript": "Field description",
"ordernum": 1,
"isrequired": 1
}
}
},
"dropdown": {
"value": {
"field": {
"type": "dropdown",
"title": "Field Title",
"perstag": "Personalized Tag",
"visible": 1,
"descript": "Field description",
"ordernum": 1,
"isrequired": 1
}
}
},
"textarea": {
"value": {
"field": {
"type": "textarea",
"title": "Field Title",
"defval": "Defaut Value",
"perstag": "Personalized Tag",
"visible": 1,
"descript": "Field description",
"ordernum": 1
}
}
},
"multiselect": {
"value": {
"field": {
"type": "listbox",
"title": "Field Title",
"perstag": "Personalized Tag",
"visible": 1,
"descript": "Field description",
"ordernum": 1,
"isrequired": 1
}
}
}
}
}
}
}
201
403
422
POST /fields
/groupMembers
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FieldAddGroupMemberRequest"
},
"examples": {
"POST": {
"value": {
"groupMember": {
"rel_id": "10",
"group_id": "1",
"ordernum": null
}
}
}
}
}
}
}
200
403
404
422
POST /groupMembers
/groups
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupCreateNewGroupRequest"
},
"examples": {
"Request Example": {
"value": {
"group": {
"title": "TEST TITLE",
"pgDeal": 1,
"descript": "Description Text",
"pgListAdd": 1,
"pgFormEdit": 1,
"pgGroupAdd": 1,
"pgListEdit": 1,
"socialdata": 0,
"pgGroupEdit": 1,
"pg_user_add": "0",
"reqApproval": 1,
"optinconfirm": "0",
"pgContactAdd": 1,
"pgDealDelete": 1,
"pgListBounce": 1,
"pgListDelete": 1,
"pgMessageAdd": 1,
"pg_user_edit": "0",
"pgContactEdit": 1,
"pgContactSync": 1,
"pgGroupDelete": 1,
"pgListHeaders": 1,
"pgMessageEdit": 1,
"pgMessageSend": 1,
"pgReportsList": 1,
"pgReportsUser": 1,
"pgTemplateAdd": 1,
"pgContactMerge": 1,
"pgDealGroupAdd": 1,
"pgDealReassign": 1,
"pgReportsTrend": 1,
"pgTemplateEdit": 1,
"pg_user_delete": "0",
"reqApproval1st": 1,
"pgContactDelete": 1,
"pgContactExport": 1,
"pgContactFields": 1,
"pgContactImport": 1,
"pgDealGroupEdit": 1,
"pgMessageDelete": 1,
"unsubscribelink": "0",
"pgContactActions": 1,
"pgContactApprove": 1,
"pgContactFilters": 1,
"pgStartupReports": 1,
"pgTemplateDelete": 1,
"pgDealGroupDelete": 1,
"pgReportsCampaign": 1,
"reqApprovalNotify": "JohnDoe@gmail.com",
"pgAutomationManage": 1,
"pgListEmailaccount": 1,
"pgPersonalizationAdd": 1,
"pgPersonalizationEdit": 1,
"pgSavedResponsesManage": 1,
"pgPersonalizationDelete": 1,
"pgStartupGettingstarted": 1
}
}
}
}
}
}
}
200
POST /groups
/contactLists
Subscribe a contact to a list or unsubscribe a contact from a list.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListUpdateListStatusForContactRequest"
},
"examples": {
"Request Example": {
"value": {
"contactList": {
"list": 2,
"status": 1,
"contact": 1
}
}
}
}
}
}
}
200
400
POST /contactLists
/fieldRels
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListCreateFieldRelationshipToListsRequest"
},
"examples": {
"Request Example": {
"value": {
"fieldRel": {
"field": 8,
"relid": 2
}
}
}
}
}
}
}
201
403
POST /fieldRels
/listGroups
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListGroupPermissionCreateRequest"
},
"examples": {
"Request Example": {
"value": {
"listGroup": {
"listid": 19,
"groupid": 1
}
}
}
}
}
}
}
201
403
POST /listGroups
/lists
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListCreateNewListRequest"
},
"examples": {
"Request Example": {
"value": {
"list": {
"name": "Name of List",
"user": 1,
"stringid": "Name-of-list",
"carboncopy": "",
"sender_url": "http://activecampaign.com",
"sender_reminder": "You are receiving this email as you subscribed to a newsletter when making an order on our site.",
"send_last_broadcast": 0,
"subscription_notify": "",
"unsubscription_notify": ""
}
}
}
}
}
}
}
200
400
403
POST /lists
/siteTrackingDomains
Add a domain to the site tracking whitelist
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListWhitelistedDomainCreateRequest"
},
"examples": {
"Request Example": {
"value": {
"siteTrackingDomain": {
"name": "example.com"
}
}
}
}
}
}
}
200
400
POST /siteTrackingDomains
/messages
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageCreateNewMessageRequest"
},
"examples": {
"Request Example": {
"value": {
"message": {
"reply2": "hello@example.com",
"subject": "You are subscribing to %LISTNAME%",
"fromname": "AC Admin",
"fromemail": "noreply@example.com",
"preheader_text": "Pre-header Text"
}
}
}
}
}
}
}
201
400
POST /messages
/accounts/{id}/notes
Create a new note for an account
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | Account’s id to assign new note to |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoteCreateAccountNoteRequest"
},
"examples": {
"Request Example": {
"value": {
"note": {
"note": "Note for the account"
}
}
}
}
}
}
}
201
POST /accounts/{id}/notes
/notes
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoteCreateNewRequest"
},
"examples": {
"Request Example": {
"value": {
"note": {
"note": "This is the text of the note",
"relid": 2,
"reltype": "Subscriber"
}
}
}
}
}
}
}
201
400
POST /notes
/ecomOrders
Create a new e-commerce order resource.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderCreateNewOrderRequest"
},
"examples": {
"Request Example": {
"value": {
"ecomOrder": {
"email": "alice@example.com",
"source": "1",
"currency": "USD",
"orderUrl": "https://example.com/orders/3246315233",
"taxAmount": 500,
"customerid": "1",
"externalid": "3246315233",
"totalPrice": 9111,
"orderNumber": "myorder-123",
"connectionid": "1",
"orderProducts": [
{
"sku": "POGO-12",
"name": "Pogo Stick",
"price": 4900,
"category": "Toys",
"imageUrl": "https://example.com/product.jpg",
"quantity": 1,
"externalid": "PROD12345",
"productUrl": "https://store.example.com/product12345",
"description": "lorem ipsum..."
},
{
"sku": "SK8BOARD145",
"name": "Skateboard",
"price": 3000,
"category": "Toys",
"imageUrl": "https://example.com/product.jpg",
"quantity": 1,
"externalid": "PROD23456",
"productUrl": "https://store.example.com/product45678",
"description": "lorem ipsum..."
}
],
"discountAmount": 100,
"orderDiscounts": [
{
"name": "1OFF",
"type": "order",
"discountAmount": 100
}
],
"shippingAmount": 200,
"shippingMethod": "UPS Ground",
"externalCreatedDate": "2016-09-13T17:41:39-04:00",
"externalUpdatedDate": "2016-09-14T17:41:39-04:00"
}
}
}
}
}
}
}
201
POST /ecomOrders
/taskOutcomes
Create a new task outcome
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OutcomeCreateTaskOutcomeRequest"
},
"examples": {
"Request Example": {
"value": {
"taskOutcome": {
"title": "Interested",
"sentiment": "Positive"
}
}
}
}
}
}
}
200
422
POST /taskOutcomes
/taskNotifications
Create a new task outcome
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReminderCreateTaskOutcomeRequest"
},
"examples": {
"Request Example": {
"value": {
"taskNotification": {
"dealTask": "1",
"interval": "123"
}
}
}
}
}
}
}
200
422
POST /taskNotifications
/savedResponses
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseCreateSavedResponseRequest"
},
"examples": {
"Request Example": {
"value": {
"savedResponse": {
"body": "Response Body",
"title": "Response Title",
"subject": "Response Subject"
}
}
}
}
}
}
}
201
422
POST /savedResponses
/customObjects/records/{schemaId}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| schemaId | path | required | string | ID of schema |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SchemaCreateOrUpdateRecordRequest"
},
"examples": {
"Create with Deal": {
"value": {
"record": {
"id": "test-obj-1X",
"fields": [
{
"id": "my-number-fieldX",
"value": 100
}
],
"schemaId": "6449c3f3-b68d-46d1-850b-c8aea998ce1b",
"externalId": "test-obj-1",
"relationships": {
"deal": [
22
]
}
}
}
},
"Create with Account": {
"value": {
"record": {
"id": "test-obj-1X",
"fields": [
{
"id": "my-number-fieldX",
"value": 100
}
],
"schemaId": "6449c3f3-b68d-46d1-850b-c8aea998ce1b",
"externalId": "test-obj-1",
"relationships": {
"account": [
123
]
}
}
}
},
"Create with Contact": {
"value": {
"record": {
"id": "test-obj-1",
"fields": [
{
"id": "my-number-fieldX",
"value": 100
}
],
"schemaId": "6449c3f3-b68d-46d1-850b-c8aea998ce1b",
"externalId": "test-obj-1",
"relationships": {
"primary-contact": [
14
]
}
}
}
}
}
}
}
}
201
400
422
POST /customObjects/records/{schemaId}
/customObjects/schemas
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SchemaCreateNewRequest"
},
"examples": {
"A single field with a relationship to a deal": {
"value": {
"schema": {
"slug": "my-object",
"fields": [
{
"id": "my-number-fieldX",
"type": "number",
"scale": 0,
"labels": {
"plural": "Numbers",
"singular": "Number"
},
"required": false
}
],
"labels": {
"plural": "My Objects",
"singular": "My Object"
},
"description": "Sample Schema",
"relationships": [
{
"id": "deal",
"labels": {
"plural": "Deals",
"singular": "Deal"
},
"hasMany": false,
"namespace": "deals",
"description": "Deals related to this object"
}
]
}
}
},
"A single field with a relationship to an account": {
"value": {
"schema": {
"slug": "my-object",
"fields": [
{
"id": "my-number-fieldX",
"type": "number",
"scale": 0,
"labels": {
"plural": "Numbers",
"singular": "Number"
},
"required": false
}
],
"labels": {
"plural": "My Objects",
"singular": "My Object"
},
"description": "Sample Schema",
"relationships": [
{
"id": "account",
"labels": {
"plural": "Accounts",
"singular": "Account"
},
"hasMany": false,
"namespace": "accounts",
"description": "Accounts related to this object"
}
]
}
}
},
"A single field with a relationship to the contact": {
"value": {
"schema": {
"slug": "my-object",
"fields": [
{
"id": "my-number-field",
"type": "number",
"scale": 0,
"labels": {
"plural": "Numbers",
"singular": "Number"
},
"required": false
}
],
"labels": {
"plural": "My Objects",
"singular": "My Object"
},
"description": "Sample Schema",
"relationships": [
{
"id": "primary-contact",
"labels": {
"plural": "Primary Contacts",
"singular": "Primary Contact"
},
"hasMany": false,
"namespace": "contacts",
"description": "Primary contact to this object"
}
]
}
}
}
}
}
}
}
201
422
POST /customObjects/schemas
/customObjects/schemas/public
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SchemaCreatePublicSchemaRequest"
},
"examples": {
"Request Example": {
"value": {
"schema": {
"slug": "event-tickets",
"appId": "cxapp-studio-app-id",
"fields": [
{
"id": "nameX",
"type": "textarea",
"labels": {
"plural": "Names",
"singular": "Name"
}
}
],
"labels": {
"plural": "Event Tickets",
"singular": "Event Ticket"
},
"description": "Event Tickets",
"relationships": [
{
"id": "primary-contactX",
"labels": {
"plural": "Primary Contacts",
"singular": "Primary Contact"
},
"namespace": "contacts",
"description": "Primary contact that owns a ticket"
}
]
}
}
}
}
}
}
}
200
400
POST /customObjects/schemas/public
/customObjects/schemas/{id}/child
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | Id of the parent schema the new child schema will extend |
200
400
POST /customObjects/schemas/{id}/child
/contactTags
Create a contact tag object
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagAddContactTagRequest"
},
"examples": {
"Example 1": {
"value": {
"contactTag": {
"tag": "20",
"contact": "1"
}
}
}
}
}
}
}
201
404
422
POST /contactTags
/tags
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagCreateTagRequest"
},
"examples": {
"Request Example": {
"value": {
"tag": {
"tag": "My Tag",
"tagType": "contact",
"description": "Description"
}
}
}
}
}
}
}
201
POST /tags
/users
Create a new user
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserCreateNewUserRequest"
},
"examples": {
"Request Example": {
"value": {
"user": {
"email": "johndoe@example.com",
"group": 4,
"lastName": "Doe",
"password": "myPa$$w0rd",
"username": "jdoe",
"firstName": "John"
}
}
}
}
}
}
}
201
400
POST /users
/webhooks
Create a new webhook
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookCreateNewWebhookRequest"
},
"examples": {
"JSON": {
"value": {
"webhook": {
"url": "http://example.com/my-hook",
"name": "My Hook",
"events": [
"subscribe",
"unsubscribe",
"sent"
],
"sources": [
"public",
"system"
]
}
}
}
}
}
}
}
201
POST /webhooks
AccountCreateAssociationRequest
{
"type": "object",
"properties": {
"accountContact": {
"type": "object",
"required": [
"account",
"contact"
],
"properties": {
"account": {
"type": "integer",
"format": "int32",
"description": "Account ID"
},
"contact": {
"type": "integer",
"format": "int32",
"description": "Contact ID"
},
"jobTitle": {
"type": "string",
"description": "Job Title of the contact at the account"
}
}
}
}
}
AccountCreateNewAccountRequest
{
"type": "object",
"properties": {
"account": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Account's name"
},
"owner": {
"type": "integer",
"format": "int32",
"default": 1,
"description": "The userId of the account owner."
},
"fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"customFieldId",
"fieldValue"
],
"properties": {
"fieldValue": {
"type": "string",
"description": "Updated field value. For `currency` field, this needs to be in cents not dollars (or 100 x Base Unit)."
},
"customFieldId": {
"type": "integer",
"format": "int32",
"description": "Field ID, ID of the Custom Field Meta Data"
},
"fieldCurrency": {
"type": "string",
"description": "Required only for the `currency` field type. The three letter currency code for the currency value"
}
}
},
"description": "Account's custom field values `{customFieldId: int, fieldValue: string, fieldCurrency?:string}[]`"
},
"accountUrl": {
"type": "string",
"description": "Account's website"
}
}
}
}
}
AccountUpdateAssociationRequest
{
"type": "object",
"properties": {
"accountContact": {
"type": "object",
"required": [
"account",
"contact"
],
"properties": {
"account": {
"type": "integer",
"format": "int32",
"description": "Account ID"
},
"contact": {
"type": "integer",
"format": "int32",
"description": "Contact ID"
},
"jobTitle": {
"type": "string",
"description": "Job Title of the contact at the account"
}
}
}
}
}
AccountUpdateExistingRequest
{
"type": "object",
"properties": {
"account": {
"type": "object",
"required": [],
"properties": {
"name": {
"type": "string",
"description": "Account's name"
},
"owner": {
"type": "integer",
"format": "int32",
"default": 1,
"description": "The userId of the Account owner."
},
"fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"customFieldId",
"fieldValue"
],
"properties": {
"fieldValue": {
"type": "string",
"description": "Updated field value. For `currency` field, this needs to be in cents not dollars (or 100 x Base Unit)."
},
"customFieldId": {
"type": "integer",
"format": "int32",
"description": "Field ID, ID of the Custom Field Meta Data"
},
"fieldCurrency": {
"type": "string",
"description": "Required only for the `currency` field type. The three letter currency code for the currency value"
}
}
},
"description": "Account's custom field values `{customFieldId: int, fieldValue: string, fieldCurrency?:string}[]`"
},
"accountUrl": {
"type": "string",
"description": "Account's website"
}
}
}
}
}
AddressCreateNewAddressRequest
{
"type": "object",
"properties": {
"address": {
"type": "object",
"required": [
"company_name",
"address_1",
"country"
],
"properties": {
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"global": {
"type": "string"
},
"country": {
"type": "string",
"description": "Accepts a (2) two character string - country code (eg 'US', 'CA', 'MX')"
},
"groupid": {
"type": "integer",
"format": "int32"
},
"allgroup": {
"type": "integer",
"format": "int32"
},
"district": {
"type": "string",
"description": "(Optional for countries that use it)"
},
"address_1": {
"type": "string"
},
"address_2": {
"type": "string"
},
"is_default": {
"type": "boolean",
"description": "Indicates default address"
},
"company_name": {
"type": "string"
}
}
}
}
}
AddressUpdateAddressRequest
{
"type": "object",
"properties": {
"address": {
"type": "object",
"required": [
"company_name",
"address_1",
"country"
],
"properties": {
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"global": {
"type": "string"
},
"country": {
"type": "string",
"description": "Accepts a (2) two character string - country code (eg 'US', 'CA', 'MX')"
},
"groupid": {
"type": "integer",
"format": "int32"
},
"allgroup": {
"type": "integer",
"format": "int32"
},
"district": {
"type": "string",
"description": "(Optional for countries that use it)"
},
"address_1": {
"type": "string"
},
"address_2": {
"type": "string"
},
"is_default": {
"type": "boolean",
"description": "Indicates default address"
},
"company_name": {
"type": "string"
}
}
}
}
}
BrandingUpdateExistingResourceRequest
{
"type": "object",
"properties": {
"branding": {
"type": "object",
"required": [],
"properties": {
"help": {
"type": "string"
},
"links": {
"type": "boolean",
"description": "External links. To enable (which is the default) exclude this parameter entirely. To disable (remove our branding), just pass this parameter with any value."
},
"favicon": {
"type": "string",
"description": "URL of the favicon."
},
"groupid": {
"type": "integer",
"format": "int32",
"default": 3,
"description": "The group ID. This value will always be 3."
},
"license": {
"type": "boolean",
"description": "unknown"
},
"version": {
"type": "boolean",
"description": "unknown"
},
"siteLogo": {
"type": "string"
},
"siteName": {
"type": "string",
"description": "Title of software. Example: 'ActiveCampaign Email Marketing'"
},
"copyright": {
"type": "boolean",
"description": "unknown"
},
"siteLogoSmall": {
"type": "string",
"description": "URL of small logo. Small logos appear in the header of the admin panel."
},
"footerHtmlValue": {
"type": "string",
"description": "Content of non-removeable footer. Example: <p>footer content here</p>"
},
"footerTextValue": {
"type": "string",
"description": "Content of non-removeable footer. Example: text footer content"
},
"headerHtmlValue": {
"type": "string",
"description": "Content of non-removable header. Example: <p>header content here</p>"
},
"headerTextValue": {
"type": "string",
"description": "Content of non-removable header. Example: text header content"
},
"adminTemplateCss": {
"type": "string",
"description": "The actual CSS. Example: test color: green; (ONLY AVAILABLE FOR CERTAIN PLANS)"
},
"adminTemplateHtm": {
"type": "string",
"description": "The actual HTML template (ONLY AVAILABLE FOR CERTAIN PLANS)"
},
"publicTemplateCss": {
"type": "string",
"description": "The actual CSS. Example: test color: green; (ONLY AVAILABLE FOR CERTAIN PLANS)"
},
"publicTemplateHtm": {
"type": "string",
"description": "The actual HTML template (ONLY AVAILABLE FOR CERTAIN PLANS)"
}
}
}
}
}
CalendarCreateFeedRequest
{
"type": "object",
"properties": {
"calendar": {
"type": "object",
"required": [
"title",
"type"
],
"properties": {
"type": {
"type": "string",
"description": "Possible Values: 'All', 'Deals', or 'Contacts'"
},
"title": {
"type": "string",
"description": "Title of the calendar feed"
},
"notification": {
"type": "boolean",
"description": "Whether or not this calendar has notifications"
}
}
}
}
}
CalendarUpdateFeedRequest
{
"type": "object",
"properties": {
"calendar": {
"type": "object",
"required": [],
"properties": {
"type": {
"type": "string",
"description": "Possible Values: 'All', 'Deals', or 'Contacts'"
},
"title": {
"type": "string",
"description": "Title of the calendar feed"
},
"notification": {
"type": "boolean",
"description": "Whether or not this calendar has notifications"
}
}
}
}
}
FieldBulkCreateCustomAccountFieldValueRequest
{
"type": "object",
"properties": {
"array": {
"type": "object",
"required": [
"customerAccountId",
"customFieldId",
"fieldValue"
],
"properties": {
"fieldValue": {
"type": "string",
"description": "Values for the field. (For currency field only, this needs to be in cents: eg, 10050 = 100.5)"
},
"customFieldId": {
"type": "integer",
"format": "int32",
"description": "The ID of the custom field metum this field value relates to"
},
"fieldCurrency": {
"type": "string",
"description": "Currency code for the money value"
},
"customerAccountId": {
"type": "integer",
"format": "int32",
"description": "The ID of the account this field value relates to"
}
}
}
}
}
FieldBulkUpdateCustomFieldValueRequest
{
"type": "object",
"properties": {
"array": {
"type": "object",
"required": [
"id",
"fieldValue"
],
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of the dealCustomFieldData to update"
},
"fieldValue": {
"type": "string",
"description": "Values for the field. (For currency field only, this needs to be in cents: eg, 10050 = 100.5)"
},
"fieldCurrency": {
"type": "string",
"description": "Currency code for the money value"
}
}
}
}
}
FieldCreateCustomFieldMetaRequest
{
"type": "object",
"properties": {
"accountCustomFieldMetum": {
"type": "object",
"required": [
"fieldLabel",
"fieldType"
],
"properties": {
"fieldType": {
"type": "string",
"description": "Type of field. Possible values are: `text`, `textarea`, `date`, `datetime`, `dropdown`, `multiselect`, `radio`, `checkbox`, `hidden`, `currency`, or `number`."
},
"fieldLabel": {
"type": "string",
"description": "Name of the field"
},
"displayOrder": {
"type": "integer",
"format": "int32",
"description": "Order for displaying the field on Manage Fields page and deal profiles"
},
"fieldDefault": {
"type": "string",
"description": "Default value of the field"
},
"fieldOptions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Options for the field. Only necessary if `field_type` is `dropdown`, `multiselect`, `radio`, or `checkbox`."
},
"isFormVisible": {
"type": "boolean",
"description": "Whether or not the field is visible on forms"
},
"fieldDefaultCurrency": {
"type": "string",
"description": "The 3-letter currency code of the default currency for the field. Only necessary if `field_type` is `currency`."
}
}
}
}
}
FieldCreateCustomFieldValueRequest
{
"type": "object",
"properties": {
"accountCustomFieldDatum": {
"type": "object",
"required": [
"customerAccountId",
"customFieldId",
"fieldValue"
],
"properties": {
"fieldValue": {
"type": "string",
"description": "Values for the field. (For `currency` field only, this needs to be in cents: eg, 10050 = 100.5)"
},
"customFieldId": {
"type": "integer",
"format": "int32",
"description": "The ID of the custom field metum this field value relates to"
},
"fieldCurrency": {
"type": "string",
"default": "Default Currency for Field",
"description": "Currency code for the money value"
},
"customerAccountId": {
"type": "integer",
"format": "int32",
"description": "The ID of the account this field value relates to"
}
}
}
}
}
FieldUpdateCustomFieldMetaRequest
{
"type": "object",
"properties": {
"accountCustomFieldMetum": {
"type": "object",
"required": [],
"properties": {
"fieldLabel": {
"type": "string",
"description": "Name of the field"
},
"displayOrder": {
"type": "integer",
"format": "int32",
"description": "Order for displaying the field on Manage Fields page and deal profiles"
},
"fieldDefault": {
"type": "string",
"description": "Default value of the field"
},
"fieldOptions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Options for the field. Only necessary if field_type is dropdown, multiselect, radio, or checkbox."
},
"isFormVisible": {
"type": "boolean",
"description": "Whether or not the field is visible on forms"
}
}
}
}
}
FieldUpdateCustomFieldValueRequest
{
"type": "object",
"properties": {
"accountCustomFieldDatum": {
"type": "object",
"required": [],
"properties": {
"fieldValue": {
"type": "string",
"description": "Values for text"
},
"fieldCurrency": {
"type": "string",
"default": "Default Currency for Field",
"description": "Currency code for the `currency` value"
}
}
}
}
}
MessageCreateNewMessageRequest
{
"type": "object",
"properties": {
"message": {
"type": "object",
"required": [
"fromname",
"email",
"reply2"
],
"properties": {
"email": {
"type": "string",
"description": "Email of sender"
},
"reply2": {
"type": "string",
"description": "Reply email for the recipient to reply to"
},
"subject": {
"type": "string",
"description": "Subject of message"
},
"fromname": {
"type": "string",
"description": "Name of sender"
},
"preheader_text": {
"type": "string",
"description": "Preheader Text"
}
}
}
}
}
NoteCreateAccountNoteRequest
{
"type": "object",
"properties": {
"note": {
"type": "object",
"required": [
"note"
],
"properties": {
"note": {
"type": "string",
"description": "Account note's content"
}
}
}
}
}
NoteUpdateNoteRequest
{
"type": "object",
"properties": {
"note": {
"type": "object",
"required": [
"note"
],
"properties": {
"note": {
"type": "string",
"description": "Account note's content"
}
}
}
}
}