ActiveCampaign Custom Objects API

The Custom Objects API from ActiveCampaign — 9 operation(s) for custom objects.

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

GET /customObjects/schemas List custom object schemas · ActiveCampaign List All Schemas #

Ask an LLM

“What custom object schemas exist in my ActiveCampaign account?”

“Can I include fields that are marked for deletion when listing schemas?”

Tell an agent

List all custom object schemas.

List up to {limit} schemas with every field shown, including deleted ones set to {showFields}.

POST /customObjects/schemas Create a custom object schema · ActiveCampaign Create a Schema #

Ask an LLM

“How do I define a new custom object type with its own fields?”

“Can I create a private schema for my account's custom data?”

Tell an agent

Create a custom object schema from this definition: {schema}.

Set up a new custom object schema called Subscriptions with the fields I list.

GET /customObjects/schemas/{id} Retrieve a custom object schema · ActiveCampaign Retrieve a Schema #

Ask an LLM

“How do I see the fields and relationships defined on one schema?”

“Can I fetch a single schema by its ID?”

Tell an agent

Get custom object schema {id}.

Show schema {id} with all fields visible using {showFields}.

DELETE /customObjects/schemas/{id} Delete a custom object schema · ActiveCampaign Delete a Schema #

Ask an LLM

“How do I remove a custom object schema I no longer use?”

“Does deleting a schema take its records with it?”

Tell an agent destructive · confirm first

Delete custom object schema {id}.

Remove the schema with ID {id} from my account.

PUT /customObjects/schemas/{schemaId} Update a custom object schema · ActiveCampaign Update a Schema #

Ask an LLM

“How do I add new fields to an existing custom object schema?”

“Can I validate a schema change without saving it?”

Tell an agent

Update schema {schemaId} with {schema}.

Dry-run my changes to schema {schemaId} with validateOnly set to {validateOnly}.

DELETE /customObjects/schemas/{schemaId}/fields/{fieldId} Delete a field from a schema · ActiveCampaign Delete a Field #

Ask an LLM

“How do I remove one field from a custom object schema?”

“What happens to record data when a schema field is deleted?”

Tell an agent destructive · confirm first

Delete field {fieldId} from schema {schemaId}.

Permanently drop the {fieldId} field on custom object schema {schemaId}.

POST /customObjects/schemas/public Create a public custom object schema · ActiveCampaign Create a Public Schema #

Ask an LLM

“How do I create a public schema that child accounts can extend?”

“Can I publish a custom object schema to share across accounts?”

Tell an agent

Create a public schema from {schema}.

Publish a new shared public custom object schema with the definition I give you.

POST /customObjects/schemas/{id}/child Create a child schema from a public schema · ActiveCampaign Create a Child Schema #

Ask an LLM

“How do I extend a public schema into a child schema in my account?”

“Can I build a child schema on top of an existing parent schema?”

Tell an agent

Create a child schema that extends parent schema {id}.

Extend public schema {id} into my account as a child schema.

GET /customObjects/records/{schemaId} List custom object records for a schema · ActiveCampaign List Records by Schema #

Ask an LLM

“How do I list the custom object records stored under a schema?”

“Can I filter records to just the ones related to a specific contact?”

Tell an agent

List records for schema {schemaId}.

List up to {limit} records of schema {schemaId} filtered by {filters}.

POST /customObjects/records/{schemaId} Create or update a custom object record · ActiveCampaign Create or Update Record #

Ask an LLM

“How do I save a custom object record, updating it if it already exists?”

“Can I upsert records into a schema by external ID?”

Tell an agent

Upsert this record into schema {schemaId}: {record}.

Create a new custom object record under schema {schemaId}.

GET /customObjects/records/{schemaId}/{recordId} Retrieve a custom object record · ActiveCampaign Get a Record by Id #

Ask an LLM

“How do I fetch one custom object record by its ID?”

“What fields come back on a single custom object record?”

Tell an agent

Get record {recordId} from schema {schemaId}.

Show custom object record {recordId} in schema {schemaId}.

DELETE /customObjects/records/{schemaId}/{recordId} Delete a custom object record by ID · ActiveCampaign Delete a Record by Id #

Ask an LLM

“How do I delete a custom object record when I have its record ID?”

“Can I remove a single record from a schema?”

Tell an agent destructive · confirm first

Delete record {recordId} from schema {schemaId}.

Remove custom object record ID {recordId} under schema {schemaId}.

DELETE /customObjects/records/{schemaId}/external/{externalId} Delete a custom object record by external ID · ActiveCampaign Delete a Record by External ID #

Ask an LLM

“Can I delete a record using my own system's external ID instead of the internal ID?”

“How do I remove a custom object record I only know by external ID?”

Tell an agent destructive · confirm first

Delete the record with external ID {externalId} from schema {schemaId}.

Remove the schema {schemaId} record whose external ID is {externalId}.

ActiveCampaign Custom Objects 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