How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ActiveCampaign AI Customization Instructions API

Manage custom instructions for AI customization profiles.

ActiveCampaign AI Customization Instructions API is one of 57 APIs that ActiveCampaign publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include AI Customization Instructions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 5 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://agency-partner-hub-web.global-aws-use1-p.app-us1.com/.

5 operations 2 paths 8 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://youraccountname.api-us1.com/api/3
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

ActiveCampaign AI Customization Instructions API declares 2 security schemes for authenticating requests. An API key is passed in the header as api-key (PartnerApiKey). It accepts HTTP bearer tokens (JWT) (PartnerJwtBearerAuth).

  • PartnerApiKey — API Token Authorization from Partner Portal
  • PartnerJwtBearerAuth — JWT Authorization header using the Partner JWT token.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

AI Customization Instructions 5

Manage custom instructions for AI customization profiles.

GET
/api/ai-customizations/v1/profiles/{profile_id}/instructions
Get a list of custom instructions for a profile
get_ai_customizations_instructions_list 1 param → 200400401404
POST
/api/ai-customizations/v1/profiles/{profile_id}/instructions
Create a new custom instruction
post_ai_customizations_instructions_create 1 param body → 201400401404422
GET
/api/ai-customizations/v1/profiles/{profile_id}/instructions/{instruction_id}
Get custom instruction by id
get_ai_customizations_instructions_get 2 params → 200400401404
DELETE
/api/ai-customizations/v1/profiles/{profile_id}/instructions/{instruction_id}
Delete custom instruction by id
delete_ai_customizations_instructions_delete 2 params → 204400401404
PATCH
/api/ai-customizations/v1/profiles/{profile_id}/instructions/{instruction_id}
Update custom instruction by id
patch_ai_customizations_instructions_update 2 params body → 200400401404422

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are CustomInstructionResponse (6 properties), ApiErrorResponse (5 properties), ApiViolation (4 properties), CreateCustomInstructionRequest (2 properties). Each schema is shown below with its type and property counts.

ApiViolation
object
4 properties 4 required
ApiErrorResponse
object
5 properties 4 required
CreateCustomInstructionResponse
object
1 property 1 required
UpdateCustomInstructionRequest
object
At least one of custominstruction or isenabled must be provided.
2 properties
CustomInstructionResponse
object
6 properties 6 required
CustomInstructionListResponse
object
1 property 1 required
CreateCustomInstructionRequest
object
2 properties 1 required
UnauthorizedResponse
Unauthorized

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activecampaign-ai-customization-instructions-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
Where this information came from

This is an independent, third-party profile of ActiveCampaign AI Customization Instructions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.