openapi: 3.0.3
info:
title: ActiveCampaign SMS Broadcast Accounts Fields API
description: API for managing SMS broadcasts, lists, metrics, and AI-powered content generation in ActiveCampaign
version: 3.0.0
contact:
name: ActiveCampaign Support
url: https://www.activecampaign.com
x-generated-from: documentation
servers:
- url: https://{yourAccountName}.api-us1.com/api/3
description: US-based Users
variables:
yourAccountName:
default: yourAccountName
security:
- ApiToken: []
tags:
- name: Fields
paths:
/fields:
post:
summary: ActiveCampaign Create a Custom Field
description: ''
operationId: create-a-contact-custom-field
requestBody:
content:
application/json:
schema:
type: object
properties:
field:
properties:
title:
type: string
description: Title of the field being created
type:
type: string
description: 'Possible Values: dropdown, hidden, checkbox, date, text, datetime, textarea, NULL, listbox, radio'
descript:
type: string
description: Description of field being created
perstag:
type: string
description: The perstag that represents the field being created
defval:
type: string
description: Default value of the field being created
show_in_list:
type: boolean
description: Show this field in the contact list view (Deprecated - no longer used)
rows:
type: integer
description: Num of rows for a textarea (Deprecated - no longer used)
format: int32
cols:
type: integer
description: Num of columns for a textarea (Deprecated - no longer used)
format: int32
visible:
type: boolean
description: Show or hide this field when using the Form Builder
service:
type: string
description: 'Possible Vales: nimble, contactually, mindbody, salesforce, highrise, google_spreadsheets, pipedrive, onepage, google_contacts, freshbooks, shopify, zendesk, etsy, NULL, bigcommerce, capsule, bigcommerce_oauth, sugarcrm, zohocrm, batchbook'
ordernum:
type: integer
description: Order of appearance in ‘My Fields’ tab.
format: int32
required:
- title
- type
type: object
examples:
textarea:
value:
field:
type: textarea
title: Field Title
descript: Field description
perstag: Personalized Tag
defval: Default Value
visible: 1
ordernum: 1
text:
value:
field:
type: text
title: Field Title
descript: Field description
perstag: Personalized Tag
defval: Default Value
visible: 1
ordernum: 1
date:
value:
field:
type: date
title: Field Title
descript: Field description
perstag: Personalized Tag
defval: '2025-01-01'
visible: 1
ordernum: 1
dropdown:
value:
field:
type: dropdown
title: Field Title
descript: Field description
perstag: Personalized Tag
visible: 1
ordernum: 1
multiselect:
value:
field:
type: listbox
title: Field Title
descript: Field description
perstag: Personalized Tag
visible: 1
ordernum: 1
radio:
value:
field:
type: radio
title: Field Title
descript: Field description
perstag: Personalized Tag
visible: 1
ordernum: 1
checkbox:
value:
field:
type: checkbox
title: Field Title
descript: Field description
perstag: Personalized Tag
visible: 1
ordernum: 1
hidden:
value:
field:
type: hidden
title: Field Title
descript: Field description
perstag: Personalized Tag
defval: Default Value
visible: 1
ordernum: 1
datetime (ISO):
value:
field:
type: datetime
title: Field Title
descript: Field description
perstag: Personalized Tag
defval: '2025-05-19T02:45:00-05:00'
visible: 1
ordernum: 1
number:
value:
field:
type: number
title: Field Title
descript: Field description
perstag: Personalized Tag
defval: '1234'
visible: 1
ordernum: 1
responses:
'201':
description: '201'
content:
application/json:
examples:
Result:
value: "{\n \"fieldOptions\": [],\n \"fieldRels\": [],\n \"fields\": [\n {\n \"title\": \"Another Test Title\",\n \"descript\": null,\n \"type\": \"\",\n \"isrequired\": \"0\",\n \"perstag\": \"ANOTHER_TEST_TITLE\",\n \"defval\": null,\n \"show_in_list\": \"0\",\n \"rows\": \"0\",\n \"cols\": \"0\",\n \"visible\": \"1\",\n \"service\": \"\",\n \"ordernum\": \"2\",\n \"cdate\": \"2018-11-15T21:43:38-06:00\",\n \"udate\": \"2018-11-15T21:43:38-06:00\",\n \"options\": [],\n \"relations\": [],\n \"links\": {\n \"options\": \"https://:account.api-us1.com/api/:version/fields/2/options\",\n \"relations\": \"https://:account.api-us1.com/api/:version/fields/2/relations\"\n },\n \"id\": \"2\"\n },\n {\n \"title\": \"Title\",\n \"descript\": \"Field description\",\n \"type\": \"textarea\",\n \"isrequired\": \"1\",\n \"perstag\": \"PERSONALIZEDTAG\",\n \"defval\": \"Defaut Value\",\n \"show_in_list\": \"1\",\n \"rows\": \"2\",\n \"cols\": \"2\",\n \"visible\": \"1\",\n \"service\": \"google\",\n \"ordernum\": \"3\",\n \"cdate\": \"2018-11-15T21:42:40-06:00\",\n \"udate\": \"2018-11-15T21:49:52-06:00\",\n \"options\": [],\n \"relations\": [],\n \"links\": {\n \"options\": \"https://:account.api-us1.com/api/:version/fields/1/options\",\n \"relations\": \"https://:account.api-us1.com/api/:version/fields/1/relations\"\n },\n \"id\": \"1\"\n }\n ],\n \"meta\": {\n \"total\": \"2\"\n }\n}"
schema:
type: object
properties:
fieldOptions:
type: array
fieldRels:
type: array
fields:
type: array
items:
type: object
properties:
title:
type: string
example: Another Test Title
descript: {}
type:
type: string
example: ''
isrequired:
type: string
example: '0'
perstag:
type: string
example: ANOTHER_TEST_TITLE
defval: {}
show_in_list:
type: string
example: '0'
rows:
type: string
example: '0'
cols:
type: string
example: '0'
visible:
type: string
example: '1'
service:
type: string
example: ''
ordernum:
type: string
example: '2'
cdate:
type: string
example: '2018-11-15T21:43:38-06:00'
udate:
type: string
example: '2018-11-15T21:43:38-06:00'
options:
type: array
relations:
type: array
links:
type: object
properties:
options:
type: string
example: https://:account.api-us1.com/api/:version/fields/2/options
relations:
type: string
example: https://:account.api-us1.com/api/:version/fields/2/relations
id:
type: string
example: '2'
meta:
type: object
properties:
total:
type: string
example: '2'
'403':
description: '403'
content:
application/json:
examples:
Result:
value: "{\n \"message\": \"Forbidden\"\n}"
schema:
type: object
properties:
message:
type: string
example: Forbidden
'422':
description: '422'
content:
application/json:
examples:
Result:
value: "{\n \"errors\": [\n {\n \"title\": \"There is already a field with this title\",\n \"detail\": \"There is already a field named 'Test Title' -- choose another name\",\n \"code\": \"duplicate\"\n }\n ]\n}"
schema:
oneOf:
- type: object
properties:
errors:
type: array
items:
type: object
properties:
title:
type: string
example: The field title was not provided.
detail:
type: string
example: ''
code:
type: string
example: field_missing
- type: object
properties:
errors:
type: array
items:
type: object
properties:
title:
type: string
example: There is already a field with this personalization tag
detail:
type: string
example: There is already a personalization tag named 'Perstag' -- choose another name
code:
type: string
example: field_invalid
- type: object
properties:
errors:
type: array
items:
type: object
properties:
title:
type: string
example: There is already a field with this title
detail:
type: string
example: There is already a field named 'Test Title' -- choose another name
code:
type: string
example: duplicate
deprecated: false
tags:
- Fields
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
get:
summary: ActiveCampaign List All Custom Fields
description: ''
operationId: retrieve-fields
parameters:
- name: limit
in: query
description: The number of fields returned per request.
schema:
type: integer
format: int32
default: 100
- name: filters[perstag]
in: query
description: 'The custom field''s persistant tag to filter by (Ex: CUSTOMER_GROUP)'
schema:
type: string
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"fieldOptions\": [],\n \"fieldRels\": [],\n \"fields\": [\n {\n \"title\": \"Another Test Title\",\n \"descript\": null,\n \"type\": \"\",\n \"isrequired\": \"0\",\n \"perstag\": \"ANOTHER_TEST_TITLE\",\n \"defval\": null,\n \"show_in_list\": \"0\",\n \"rows\": \"0\",\n \"cols\": \"0\",\n \"visible\": \"1\",\n \"service\": \"\",\n \"ordernum\": \"2\",\n \"cdate\": \"2018-11-15T21:43:38-06:00\",\n \"udate\": \"2018-11-15T21:43:38-06:00\",\n \"options\": [],\n \"relations\": [],\n \"links\": {\n \"options\": \"https://:account.api-us1.com/api/:version/fields/2/options\",\n \"relations\": \"https://:account.api-us1.com/api/:version/fields/2/relations\"\n },\n \"id\": \"2\"\n },\n {\n \"title\": \"Title\",\n \"descript\": \"Field description\",\n \"type\": \"textarea\",\n \"isrequired\": \"1\",\n \"perstag\": \"PERSONALIZEDTAG\",\n \"defval\": \"Defaut Value\",\n \"show_in_list\": \"1\",\n \"rows\": \"2\",\n \"cols\": \"2\",\n \"visible\": \"1\",\n \"service\": \"google\",\n \"ordernum\": \"3\",\n \"cdate\": \"2018-11-15T21:42:40-06:00\",\n \"udate\": \"2018-11-15T21:49:52-06:00\",\n \"options\": [],\n \"relations\": [],\n \"links\": {\n \"options\": \"https://:account.api-us1.com/api/:version/fields/1/options\",\n \"relations\": \"https://:account.api-us1.com/api/:version/fields/1/relations\"\n },\n \"id\": \"1\"\n }\n ],\n \"meta\": {\n \"total\": \"2\"\n }\n}"
schema:
type: object
properties:
fieldOptions:
type: array
fieldRels:
type: array
fields:
type: array
items:
type: object
properties:
title:
type: string
example: Another Test Title
descript: {}
type:
type: string
example: ''
isrequired:
type: string
example: '0'
perstag:
type: string
example: ANOTHER_TEST_TITLE
defval: {}
show_in_list:
type: string
example: '0'
rows:
type: string
example: '0'
cols:
type: string
example: '0'
visible:
type: string
example: '1'
service:
type: string
example: ''
ordernum:
type: string
example: '2'
cdate:
type: string
example: '2018-11-15T21:43:38-06:00'
udate:
type: string
example: '2018-11-15T21:43:38-06:00'
options:
type: array
relations:
type: array
links:
type: object
properties:
options:
type: string
example: https://:account.api-us1.com/api/:version/fields/2/options
relations:
type: string
example: https://:account.api-us1.com/api/:version/fields/2/relations
id:
type: string
example: '2'
meta:
type: object
properties:
total:
type: string
example: '2'
deprecated: false
tags:
- Fields
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/fields/{id}:
put:
summary: ActiveCampaign Update a Custom Field
description: ''
operationId: update-a-field
parameters:
- name: id
in: path
description: ID of the field to update
schema:
type: integer
format: int32
required: true
requestBody:
content:
application/json:
schema:
type: object
properties:
field:
properties:
type:
type: string
description: 'Possible Values: dropdown, hidden, checkbox, date, datetime, text, textarea, NULL, listbox, radio'
title:
type: string
description: Title of the field being updated
descript:
type: string
description: Description of field being updated
perstag:
type: string
description: The perstag that represents the field being created
defval:
type: string
description: Default value of the field being created
show_in_list:
type: boolean
description: Show this field in the contact list view (No longer Used)
visible:
type: boolean
description: Setting to show/hide field
service:
type: string
description: 'Possible Vales: nimble, contactually, mindbody, salesforce, highrise, google_spreadsheets, pipedrive, onepage, google_contacts, freshbooks, shopify, zendesk, etsy, NULL, bigcommerce, capsule, bigcommerce_oauth, sugarcrm, zohocrm, batchbook'
ordernum:
type: string
description: Order of appearance in ‘My Fields’ tab.
required: []
type: object
examples:
Request Example:
value:
field:
type: textarea
title: Title
descript: Field description
perstag: Personalized Tag
defval: Defaut Value
show_in_list: 1
rows: 2
cols: 2
visible: 1
service: google
ordernum: 3
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"field\": {\n \"title\": \"Title\",\n \"descript\": \"Field description\",\n \"type\": \"textarea\",\n \"isrequired\": 0,\n \"perstag\": \"PERSONALIZEDTAG\",\n \"defval\": \"Defaut Value\",\n \"show_in_list\": 1,\n \"rows\": 2,\n \"cols\": 2,\n \"visible\": 1,\n \"service\": \"google\",\n \"ordernum\": 3,\n \"cdate\": \"2018-09-25T16:06:08-05:00\",\n \"udate\": \"2018-09-29T18:23:20-05:00\",\n \"links\": {\n \"options\": \"https://:account.api-us1.com/api/:version/fields/3/options\",\n \"relations\": \"https://:account.api-us1.com/api/:version/fields/3/relations\"\n },\n \"id\": \"3\"\n }\n}"
schema:
type: object
properties:
field:
type: object
properties:
title:
type: string
example: Title
descript:
type: string
example: Field description
type:
type: string
example: textarea
isrequired:
type: integer
example: 0
default: 0
perstag:
type: string
example: PERSONALIZEDTAG
defval:
type: string
example: Defaut Value
show_in_list:
type: integer
example: 1
default: 0
rows:
type: integer
example: 2
default: 0
cols:
type: integer
example: 2
default: 0
visible:
type: integer
example: 1
default: 0
service:
type: string
example: google
ordernum:
type: integer
example: 3
default: 0
cdate:
type: string
example: '2018-09-25T16:06:08-05:00'
udate:
type: string
example: '2018-09-29T18:23:20-05:00'
links:
type: object
properties:
options:
type: string
example: https://:account.api-us1.com/api/:version/fields/3/options
relations:
type: string
example: https://:account.api-us1.com/api/:version/fields/3/relations
id:
type: string
example: '3'
'403':
description: '403'
content:
application/json:
examples:
Result:
value: "{\n \"message\": \"Forbidden\"\n}"
schema:
type: object
properties:
message:
type: string
example: Forbidden
deprecated: false
tags:
- Fields
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
get:
summary: ActiveCampaign Get a Custom Field by ID
description: ''
operationId: retrieve-a-custom-field-contact
parameters:
- name: id
in: path
description: ID of the field to retrieve
schema:
type: integer
format: int32
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"fieldOptions\": [],\n \"fieldRels\": [\n {\n \"field\": \"1\",\n \"relid\": \"0\",\n \"dorder\": \"0\",\n \"cdate\": \"2018-08-17T11:09:43-05:00\",\n \"links\": [],\n \"id\": \"1\"\n }\n ],\n \"field\": {\n \"title\": \"test\",\n \"descript\": \"\",\n \"type\": \"text\",\n \"isrequired\": \"0\",\n \"perstag\": \"TEST\",\n \"defval\": \"\",\n \"show_in_list\": \"0\",\n \"rows\": \"0\",\n \"cols\": \"0\",\n \"visible\": \"1\",\n \"service\": \"\",\n \"ordernum\": \"1\",\n \"cdate\": \"2018-08-17T11:09:43-05:00\",\n \"udate\": \"2018-08-17T11:09:43-05:00\",\n \"options\": [],\n \"relations\": [\n \"1\"\n ],\n \"links\": {\n \"options\": \"https://:account.api-us1.com/api/3/fields/1/options\",\n \"relations\": \"https://:account.api-us1.com/api/3/fields/1/relations\"\n },\n \"id\": \"1\"\n }\n}"
schema:
type: object
properties:
fieldOptions:
type: array
fieldRels:
type: array
items:
type: object
properties:
field:
type: string
example: '1'
relid:
type: string
example: '0'
dorder:
type: string
example: '0'
cdate:
type: string
example: '2018-08-17T11:09:43-05:00'
links:
type: array
id:
type: string
example: '1'
field:
type: object
properties:
title:
type: string
example: test
descript:
type: string
example: ''
type:
type: string
example: text
isrequired:
type: string
example: '0'
perstag:
type: string
example: TEST
defval:
type: string
example: ''
show_in_list:
type: string
example: '0'
rows:
type: string
example: '0'
cols:
type: string
example: '0'
visible:
type: string
example: '1'
service:
type: string
example: ''
ordernum:
type: string
example: '1'
cdate:
type: string
example: '2018-08-17T11:09:43-05:00'
udate:
type: string
example: '2018-08-17T11:09:43-05:00'
options:
type: array
relations:
type: array
items:
type: string
example: '1'
links:
type: object
properties:
options:
type: string
example: https://:account.api-us1.com/api/3/fields/1/options
relations:
type: string
example: https://:account.api-us1.com/api/3/fields/1/relations
id:
type: string
example: '1'
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
tags:
- Fields
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
summary: ActiveCampaign Delete a Custom Field
description: ''
operationId: delete-a-field
parameters:
- name: id
in: path
description: ID of the field option to delete
schema:
type: integer
format: int32
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
'404':
description: '404'
content:
application/json:
examples:
Result:
value: "{\n \"message\": \"No Result found for Field with id 99\"\n}"
schema:
type: object
properties:
message:
type: string
example: No Result found for Field with id 99
deprecated: false
tags:
- Fields
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/fieldRels:
post:
summary: ActiveCampaign Create a Custom Field Relationship to List(s)
description: ''
operationId: create-a-custom-field-relationship-to-lists
requestBody:
content:
application/json:
schema:
# --- truncated at 32 KB (76 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/openapi/activecampaign-fields-api-openapi.yml