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 Fields API

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

ActiveCampaign Fields 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 Fields. 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 7 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 7 paths 0 schemas 3 DELETE4 GET4 POST2 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 Fields 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 7 paths, the API surfaces 13 operations — 3 DELETE, 4 GET, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Fields 13
POST
/fields
ActiveCampaign Create a Custom Field
create-a-contact-custom-field body → 201403422
GET
/fields
ActiveCampaign List All Custom Fields
retrieve-fields 2 params → 200
PUT
/fields/{id}
ActiveCampaign Update a Custom Field
update-a-field 1 param body → 200403
GET
/fields/{id}
ActiveCampaign Get a Custom Field by ID
retrieve-a-custom-field-contact 1 param → 200400
DELETE
/fields/{id}
ActiveCampaign Delete a Custom Field
delete-a-field 1 param → 200404
POST
/fieldRels
ActiveCampaign Create a Custom Field Relationship to List(s)
create-a-custom-field-relationship-to-lists body → 201403
POST
/fieldOption/bulk
ActiveCampaign Create Custom Field Options
create-custom-field-options body → 201422
DELETE
/fieldRels/{fieldRelId}
ActiveCampaign Delete a Custom Field Relationship to List(s)
delete-a-custom-field-relationship-to-lists 1 param → 200403
POST
/fieldValues
ActiveCampaign Create a Custom Field Value
create-fieldvalue body → 200403
GET
/fieldValues
ActiveCampaign List All Custom Field Values
list-all-custom-field-values 2 params → 200400
GET
/fieldValues/{id}
ActiveCampaign Retrieve a Custom Field Value
retrieve-a-fieldvalues 1 param → 200403
PUT
/fieldValues/{id}
ActiveCampaign Update a Custom Field Value for Contact
update-a-custom-field-value-for-contact 1 param body → 200400
DELETE
/fieldValues/{id}
ActiveCampaign Delete a Custom Field Value
delete-a-fieldvalue-1 1 param → 200403

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activecampaign-fields-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 Custom Objects API