Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ActiveCampaign Custom Objects API

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

ActiveCampaign Custom Objects API is one of 36 APIs that ActiveCampaign publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 9 JSON Schema definitions.

Tagged areas include Custom Objects. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an AsyncAPI specification, and 9 JSON Schemas.

This API exposes 13 operations across 9 paths. It is described by OpenAPI 3.0.3, at version 3.0.0.

Requests are made against a single base URL, https://{yourAccountName}.api-us1.com/api/3.

13 operations 9 paths 0 schemas 4 DELETE4 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.0.0
Base URL
https://youraccountname.api-us1.com/api/3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

ActiveCampaign Custom Objects API declares 1 security scheme for authenticating requests. An API key is passed in the header as Api-Token (ApiToken). By default, every request must be authenticated.

  • ApiToken — Your ActiveCampaign API token

Paths & Operations 13

Across 9 paths, the API surfaces 13 operations — 4 DELETE, 4 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Custom Objects 13
GET
/customObjects/schemas
ActiveCampaign List All Schemas
list-all-schemas 5 params → 200400
POST
/customObjects/schemas
ActiveCampaign Create a Schema
create-a-schema body → 201422
GET
/customObjects/schemas/{id}
ActiveCampaign Retrieve a Schema
retrieve-a-schema 2 params → 200404
DELETE
/customObjects/schemas/{id}
ActiveCampaign Delete a Schema
delete-a-schema 1 param → 200404
PUT
/customObjects/schemas/{schemaId}
ActiveCampaign Update a Schema
update-a-schema 3 params body → 200404422
DELETE
/customObjects/schemas/{schemaId}/fields/{fieldId}
ActiveCampaign Delete a Field
delete-a-field-1 3 params → 202
POST
/customObjects/schemas/public
ActiveCampaign Create a Public Schema
create-a-public-schema body → 200400
POST
/customObjects/schemas/{id}/child
ActiveCampaign Create a Child Schema
create-a-child-schema 1 param → 200400
GET
/customObjects/records/{schemaId}
ActiveCampaign List Records by Schema
list-records-created-from-a-schema 4 params → 200400404
POST
/customObjects/records/{schemaId}
ActiveCampaign Create or Update Record
create-or-update-record 1 param body → 201400422
GET
/customObjects/records/{schemaId}/{recordId}
ActiveCampaign Get a Record by Id
get-a-single-record 2 params → 200400
DELETE
/customObjects/records/{schemaId}/{recordId}
ActiveCampaign Delete a Record by Id
delete-a-record 2 params → 202400
DELETE
/customObjects/records/{schemaId}/external/{externalId}
ActiveCampaign Delete a Record by External ID
delete-a-record-by-external-id 2 params → 202400

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activecampaign-custom-objects-api-openapi.yml Raw ↑

Other APIs ActiveCampaign publishes across the network.

ActiveCampaign Accounts API
ActiveCampaign Addresses API
ActiveCampaign AI API
ActiveCampaign Automations API
ActiveCampaign Branding API
ActiveCampaign Broadcasts API
ActiveCampaign Bulk Import API
ActiveCampaign Calendars API
ActiveCampaign Campaigns API
ActiveCampaign Contacts API
ActiveCampaign Credits API
ActiveCampaign Deals API