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

The Partners API from ActiveCampaign — 36 operation(s) for resellers and agency partners: child-account creation and listing, account cloning snapshots, AI customization profiles, documents and custom instructions, CRM reporting and sync configuration, insight cards, storage quota and locale catalogs. It is a separate credential surface from the customer v3 API.

ActiveCampaign Partners API is one of 43 APIs that ActiveCampaign publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Partners, Resellers, Child Accounts, and Artificial Intelligence. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 36 operations across 23 paths, organized into 11 resource areas, and defines 66 schemas. It is described by OpenAPI 3.0.3, 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/.

36 operations 23 paths 66 schemas 4 DELETE20 GET5 PATCH5 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://agency-partner-hub-web.global-aws-use1-p.app-us1.com/
Authentication
API Key, HTTP Bearer
Resource Areas
11

Authentication & Security 2

ActiveCampaign Partners 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 36

Across 23 paths, the API surfaces 36 operations — 4 DELETE, 20 GET, 5 PATCH, 5 POST, 2 PUT. They span 11 resource areas, including AI Customization Profiles, AI Customization Documents, AI Customization Instructions, Child Account Snapshots, Child Accounts, CRM Reporting, CRM Sync, CRM Sync Settings, and 3 more. Each is listed below with its method, path, parameters, and response codes.

AI Customization Profiles 7

Manage AI customization profiles.

GET
/api/ai-customizations/v1/profiles
Get a list of AI customization profiles
get_ai_customizations_profiles_list → 200400401404
POST
/api/ai-customizations/v1/profiles
Create a new AI customization profile
post_ai_customizations_profiles_create body → 201400401404409422
GET
/api/ai-customizations/v1/profiles/{id}
Get profile by id
get_ai_customizations_profiles_get 1 param → 200400401404
DELETE
/api/ai-customizations/v1/profiles/{id}
Delete profile by id
delete_ai_customizations_profiles_delete 1 param → 204400401404
PATCH
/api/ai-customizations/v1/profiles/{id}
Update profile by id
patch_ai_customizations_profiles_update 1 param body → 200400401404409422
GET
/api/ai-customizations/v1/profiles/child-accounts/{childAccountId}
Get the AI customization profile assigned to a child account
get_ai_customizations_profiles_get_by_child_account 1 param → 200400401404
PATCH
/api/ai-customizations/v1/profiles/{id}/accounts
Assign child accounts to a profile
patch_ai_customizations_profiles_assign_accounts 1 param body → 204400401403404422
AI Customization Documents 6

Manage documents attached to AI customization profiles.

GET
/api/ai-customizations/v1/profiles/{profile_id}/documents
Get a list of documents for a profile
get_ai_customizations_documents_list 3 params → 200400401404
POST
/api/ai-customizations/v1/profiles/{profile_id}/documents
Upload a document to a profile
post_ai_customizations_documents_upload 1 param body → 201400401404422
GET
/api/ai-customizations/v1/profiles/{profile_id}/documents/{document_id}
Get document by id
get_ai_customizations_documents_get 2 params → 200400401404
DELETE
/api/ai-customizations/v1/profiles/{profile_id}/documents/{document_id}
Delete document by id
delete_ai_customizations_documents_delete 2 params → 204400401404
PATCH
/api/ai-customizations/v1/profiles/{profile_id}/documents/{document_id}
Update document by id
patch_ai_customizations_documents_update 2 params body → 200400401404422
GET
/api/ai-customizations/v1/profiles/{profile_id}/documents/{document_id}/download
Get a presigned download URL for a document
get_ai_customizations_documents_download 2 params → 200400401404
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
Child Account Snapshots 4

Create and manage snapshots of reseller child accounts.

GET
/api/child-account-snapshots/v1/status
Get a list of account cloning statuses
get_child_account_snapshots_get_list 3 params → 200400401404
GET
/api/child-account-snapshots/v1/
Get a list of snapshots
get_child_account_snapshots_list_snapshot_by_reseller 3 params → 200400401404
POST
/api/child-account-snapshots/v1/
Create a new snapshot
post_child_account_snapshots_create_snapshot body → 201400401404422
DELETE
/api/child-account-snapshots/v1/{snapshotId}
Delete snapshot by id
delete_child_account_snapshots_delete_snapshot 1 param → 200400401404
Child Accounts 3

Manage reseller child accounts.

GET
/api/child-accounts/v1/
Get a list of child accounts
get_child_accounts_get_list 7 params → 200400401404
POST
/api/child-accounts/v1/
Create a new account
post_child_accounts_create body → 200400401404422
GET
/api/child-accounts/v1/snapshots
Get a list of accounts that can be used to create snapshots.
get_child_accounts_get_for_snapshots 3 params → 200400401404503
CRM Reporting 2

Read-only CRM pipeline reporting and metrics.

GET
/api/crm-reporting/v1/pipelines
List sync-enabled pipelines with deal counts, conversion %, revenue, and top account.
get_crm_reporting_list_pipelines 6 params → 200400401404
GET
/api/crm-reporting/v1/pipelines/summary
Aggregate summary metric cards: deal counts, revenue, conversion %, average deal revenue.
get_crm_reporting_pipelines_summary 4 params → 200400401404
CRM Sync 3

Configure CRM synchronization for HQ pipelines.

GET
/api/crm-sync/v1/pipelines
Get a list of HQ pipelines with CRM sync status
get_crm_sync_list_pipelines 5 params → 200400401404
GET
/api/crm-sync/v1/pipelines/{pipeline_id}/sync
Get pipeline CRM sync configuration
get_crm_sync_get_pipeline_sync_config 1 param → 200400401404
PUT
/api/crm-sync/v1/pipelines/{pipeline_id}/sync
Upsert pipeline CRM sync configuration (enable/disable and targets)
put_crm_sync_put_pipeline_sync_config 1 param body → 204400401404422
CRM Sync Settings 2

Manage CRM synchronization settings.

GET
/api/crm-sync/v1/settings
Get CRM sync settings
get_crm_sync_settings_get → 200400401404
PUT
/api/crm-sync/v1/settings
Update CRM sync settings
put_crm_sync_settings_update body → 200400401404422
Files 1

Storage quota information for the partner.

GET
/api/files/v1/quota
Get storage quota status
get_files_quota_status → 200400401404
Insight Cards 2

Retrieve and update partner insight cards.

GET
/api/insight-cards/v1/insights
Get a list of the latest insight cards
get_insight_cards_get_list_latest → 200400401404
PATCH
/api/insight-cards/v1/insights/{id}
Update insight card state
patch_insight_cards_update_state 1 param body → 200400401404422
Locales 1

Supported language and timezone catalogs.

GET
/api/locales/v1/catalogs
Get supported language and timezone catalogs.
get_locales_get_catalogs → 200400401404503

Schemas 66

The contract defines 66 schemas that model the data the API accepts and returns. The most detailed are CreateAccountRequestDto (14 properties), AccountCloningStatusResponse (12 properties), ProfileDocumentResponse (9 properties), PipelineSummary (8 properties). Each schema is shown below with its type and property counts.

CrmSyncPipelinesListQuery
object
5 properties
CrmReportingPipelinesListQuery
object
6 properties 2 required
ChildAccountsPaginationMetadata
object
4 properties 4 required
AICustomizationsPaginationMetadata
object
4 properties 4 required
CreateProfileRequest
object
1 property 1 required
UpdateProfileRequest
object
1 property 1 required
DocumentsListQuery
object
2 properties
UpdateDocumentRequest
object
3 properties 1 required
CreateCustomInstructionRequest
object
2 properties 1 required
UpdateCustomInstructionRequest
object
At least one of custominstruction or isenabled must be provided.
2 properties
AssignAccountsToProfileRequest
object
You cannot provide non-empty accountIds and set assignToAllAccounts to true at the same time.
3 properties
AM2CreateSnapshotRequest
object
2 properties 2 required
ProductEntitlementLimitDto
object
3 properties
ProductEntitlementPricingDto
object
2 properties 2 required
ProductEntitlementDto
object
3 properties
ProductDto
object
6 properties 3 required
CreateAccountRequestDto
object
14 properties 7 required
ChildAccountsListQuery
object
7 properties
PipelinesSummaryQuery
object
4 properties 2 required
UpsertPipelineSyncTargetRequest
object
3 properties
UpsertPipelineSyncRequest
object
2 properties 1 required
UpdateSettingsRequest
object
1 property 1 required
UpdateStateMetadataInsightCardRequest
object
1 property 1 required
UpdateStateInsightCardRequest
object
2 properties 2 required
ApiViolation
object
4 properties 4 required
ApiErrorResponse
object
5 properties 4 required
ChildAccountData
object
5 properties 3 required
ProfileResponse
object
7 properties 6 required
ProfileListResponse
object
1 property 1 required
UnauthorizedResponse
Unauthorized
CreateProfileResponse
object
1 property 1 required
ChildAccountProfileResponse
object
5 properties 5 required
ProfileDocumentResponse
object
9 properties 8 required
ProfileDocumentListResponse
object
2 properties 2 required
DocumentDownloadUrlResponse
object
2 properties 2 required
CustomInstructionResponse
object
6 properties 6 required
CustomInstructionListResponse
object
1 property 1 required
CreateCustomInstructionResponse
object
1 property 1 required
AccountCloningStatusResponse
object
12 properties 10 required
AccountCloningStatusListPagination
object
4 properties 4 required
AccountCloningStatusListResponse
object
2 properties 2 required
AM2SnapshotResponse
object
7 properties 5 required
AM2GetSnapshotsResponse
object
2 properties 1 required
ChildAccountResponse
object
5 properties 3 required
ChildAccountListResponse
object
2 properties 2 required
AccountForSnapshotResponse
object
3 properties 3 required
ListAccountForSnapshotResponse
object
1 property 1 required
RangeInfo
object
3 properties 3 required
TopAccount
object
2 properties 2 required
PipelineSummary
object
8 properties 7 required
Pagination
object
4 properties 4 required
PipelinesListResponse
object
4 properties 4 required
DealsBucket
object
2 properties 2 required
PipelinesSummary
object
5 properties 5 required
PipelinesSummaryResponse
object
3 properties 3 required
PipelineResponse
object
7 properties 5 required
PipelineListPagination
object
4 properties 4 required
PipelineListResponse
object
2 properties 2 required
PipelineSyncTargetResponse
object
3 properties 2 required
PipelineSyncConfigResponse
object
3 properties 3 required
SettingsResponse
object
1 property 1 required
QuotaStatusResponse
object
3 properties 3 required
InsightCardMetadata
object
6 properties 5 required
InsightCardResponse
object
5 properties 5 required
InsightCardListResponse
array
LocaleCatalogsResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activecampaign-partners-api-openapi.json 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 Partners 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.