ActiveCampaign Fields API

The Fields API from ActiveCampaign — 7 operation(s) for fields.

Documentation GitHub OpenAPI

Operations 13

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /fields Create a contact custom field · ActiveCampaign Create a Custom Field #

Ask an LLM

“How do I add a custom field like Company Size to contacts?”

“Can I create a dropdown or date custom field for contacts?”

Tell an agent

Create a contact custom field with {field}.

Add a Birthday date field to contacts.

GET /fields List contact custom fields · ActiveCampaign List All Custom Fields #

Ask an LLM

“What custom contact fields exist in my ActiveCampaign account?”

“Can I find a custom field by its personalization tag?”

Tell an agent

List all contact custom fields.

Find the custom field with personalization tag {perstag}.

PUT /fields/{id} Update a contact custom field · ActiveCampaign Update a Custom Field #

Ask an LLM

“Can I rename a contact custom field or change its type?”

“Is it possible to edit a custom field's default value?”

Tell an agent

Update custom field {id} with {field}.

Rename contact custom field {id}.

GET /fields/{id} Get a contact custom field · ActiveCampaign Get a Custom Field by ID #

Ask an LLM

“Where do I see the definition of one contact custom field?”

“What type and tag does contact field 9 have?”

Tell an agent

Show contact custom field {id}.

Get the settings of custom field {id}.

DELETE /fields/{id} Delete a contact custom field · ActiveCampaign Delete a Custom Field #

Ask an LLM

“How do I delete a contact custom field I don't need?”

“Does removing a custom field erase it from every contact?”

Tell an agent destructive · confirm first

Delete contact custom field {id}.

Remove the unused contact field {id}.

POST /fieldRels Attach a custom field to lists · ActiveCampaign Create a Custom Field Relationship to List(s) #

Ask an LLM

“Can I make a custom field available only on certain lists?”

“How do I link a contact field to a list?”

Tell an agent

Relate a custom field to lists using {fieldRel}.

Make the Company Size field available on my Newsletter list.

POST /fieldOption/bulk Add options to a dropdown custom field · ActiveCampaign Create Custom Field Options #

Ask an LLM

“How do I add choices to a dropdown or checkbox custom field?”

“Can I set one of the field options as the default?”

Tell an agent

Add option {value} labeled {label} to field {field}.

Add option {value} to custom field {field} and make it the default ({isdefault}).

DELETE /fieldRels/{fieldRelId} Detach a custom field from a list · ActiveCampaign Delete a Custom Field Relationship to List(s) #

Ask an LLM

“Can I stop a custom field from showing on a particular list?”

“How do I remove a field-to-list relationship?”

Tell an agent destructive · confirm first

Delete field relationship {fieldRelId}.

Unlink the custom field from its list via relationship {fieldRelId}.

POST /fieldValues Set a custom field value on a contact · ActiveCampaign Create a Custom Field Value #

Ask an LLM

“How do I fill in a custom field for one contact?”

“Can I save a custom field value and fall back to the field's defaults?”

Tell an agent

Set a contact custom field value with {fieldValue}.

Store a contact's Company Size value, using defaults where blank ({useDefaults}).

GET /fieldValues List contact custom field values · ActiveCampaign List All Custom Field Values #

Ask an LLM

“Which contacts have a particular value in a custom field?”

“Can I list all values stored for one contact field?”

Tell an agent

List values stored for custom field {fieldid}.

Find contact field values equal to {val}.

GET /fieldValues/{id} Get a contact custom field value · ActiveCampaign Retrieve a Custom Field Value #

Ask an LLM

“Where do I look up one stored contact field value by ID?”

“What value is saved in contact field value record 55?”

Tell an agent

Show contact field value {id}.

Get stored custom field value {id}.

PUT /fieldValues/{id} Change a contact custom field value · ActiveCampaign Update a Custom Field Value for Contact #

Ask an LLM

“Can I change a custom field value already set on a contact?”

“How do I correct a contact's saved field value?”

Tell an agent

Update contact field value {id} with {fieldValue}.

Correct the saved contact field value {id}.

DELETE /fieldValues/{id} Clear a contact custom field value · ActiveCampaign Delete a Custom Field Value #

Ask an LLM

“Is it possible to erase a custom field value from a contact?”

“What removes one stored contact field value?”

Tell an agent destructive · confirm first

Delete contact field value {id}.

Clear the contact's custom field entry {id}.

ActiveCampaign Fields API

Operations 13

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification