ActiveCampaign

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.

GitHub OpenAPI

Documentation

📖
Documentation
https://developers.activecampaign.com/reference/overview
📖
Authentication
https://developers.activecampaign.com/reference/authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/openapi/activecampaign-partners-api-openapi.json

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/overlays/activecampaign-partners-overlay.yaml

OpenAPI Specification

activecampaign-partners-api-openapi.json Raw ↑ 
{"openapi":"3.0.3","info":{"title":"Partners API","description":"Partners Hub API documentation","version":"1.0.0"},"servers":[{"url":"https://agency-partner-hub-web.global-aws-use1-p.app-us1.com/","description":"Production"}],"paths":{"/api/ai-customizations/v1/profiles":{"get":{"tags":["AI Customization Profiles"],"operationId":"get_ai_customizations_profiles_list","responses":{"200":{"description":"Profile details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileListResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":400,"detail":"Bad Request"}}}},"401":{"description":"Authorization error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":404,"detail":"Not Found"}}}}},"security":[{"PartnerApiKey":[]},{"PartnerJwtBearerAuth":[]}],"summary":"Get a list of AI customization profiles"},"post":{"tags":["AI Customization Profiles"],"operationId":"post_ai_customizations_profiles_create","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProfileRequest"}}}},"responses":{"201":{"description":"Profile details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProfileResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":400,"detail":"Bad Request"}}}},"401":{"description":"Authorization error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":404,"detail":"Not Found"}}}},"409":{"description":"Request failed due to a conflict with the current state of AI customization profiles","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":409,"detail":"A profile with this name already exists"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://symfony.com/errors/validation","title":"Validation Failed","status":422,"detail":"assign_to_all_accounts: This value should be of type bool.","violations":[{"propertyPath":"assign_to_all_accounts","title":"This value should be of type bool.","template":"This value should be of type {{ type }}.","parameters":{"{{ type }}":"bool"}}]}}}}},"security":[{"PartnerApiKey":[]},{"PartnerJwtBearerAuth":[]}],"summary":"Create a new AI customization profile"}},"/api/ai-customizations/v1/profiles/{id}":{"get":{"tags":["AI Customization Profiles"],"operationId":"get_ai_customizations_profiles_get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","maximum":9223372036854776000,"minimum":1,"pattern":"[1-9][0-9]{0,18}"}}],"responses":{"200":{"description":"Profile details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":400,"detail":"Bad Request"}}}},"401":{"description":"Authorization error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":404,"detail":"Not Found"}}}}},"security":[{"PartnerApiKey":[]},{"PartnerJwtBearerAuth":[]}],"summary":"Get profile by id"},"delete":{"tags":["AI Customization Profiles"],"summary":"Delete profile by id","operationId":"delete_ai_customizations_profiles_delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","maximum":9223372036854776000,"minimum":1,"pattern":"[1-9][0-9]{0,18}"}}],"responses":{"204":{"description":"Profile was successfully deleted (204 No Content)."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":400,"detail":"Bad Request"}}}},"401":{"description":"Authorization error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":404,"detail":"Not Found"}}}}},"security":[{"PartnerApiKey":[]},{"PartnerJwtBearerAuth":[]}]},"patch":{"tags":["AI Customization Profiles"],"operationId":"patch_ai_customizations_profiles_update","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","maximum":9223372036854776000,"minimum":1,"pattern":"[1-9][0-9]{0,18}"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProfileRequest"}}}},"responses":{"200":{"description":"Profile updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":400,"detail":"Bad Request"}}}},"401":{"description":"Authorization error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":404,"detail":"Not Found"}}}},"409":{"description":"Request failed due to a conflict with the current state of AI customization profiles","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":409,"detail":"A profile with this name already exists"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://symfony.com/errors/validation","title":"Validation Failed","status":422,"detail":"assign_to_all_accounts: This value should be of type bool.","violations":[{"propertyPath":"assign_to_all_accounts","title":"This value should be of type bool.","template":"This value should be of type {{ type }}.","parameters":{"{{ type }}":"bool"}}]}}}}},"security":[{"PartnerApiKey":[]},{"PartnerJwtBearerAuth":[]}],"summary":"Update profile by id"}},"/api/ai-customizations/v1/profiles/child-accounts/{childAccountId}":{"get":{"tags":["AI Customization Profiles"],"operationId":"get_ai_customizations_profiles_get_by_child_account","parameters":[{"name":"childAccountId","in":"path","required":true,"schema":{"type":"integer","maximum":9223372036854776000,"minimum":1,"pattern":"[1-9][0-9]{0,18}"}}],"responses":{"200":{"description":"AI customization profile assigned to the child account, or null when none is assigned (or the account does not belong to the reseller).","content":{"application/json":{"schema":{"properties":{"profile":{"oneOf":[{"$ref":"#/components/schemas/ChildAccountProfileResponse"}],"nullable":true,"type":"object"}},"type":"object","additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":400,"detail":"Bad Request"}}}},"401":{"description":"Authorization error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":404,"detail":"Not Found"}}}}},"security":[{"PartnerJwtBearerAuth":[]}],"summary":"Get the AI customization profile assigned to a child account"}},"/api/ai-customizations/v1/profiles/{profile_id}/documents":{"get":{"tags":["AI Customization Documents"],"operationId":"get_ai_customizations_documents_list","parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"type":"integer","maximum":9223372036854776000,"minimum":1,"pattern":"[1-9][0-9]{0,18}"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"minimum":1}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":20,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"Paginated list of documents for the profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileDocumentListResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":400,"detail":"Bad Request"}}}},"401":{"description":"Authorization error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"404":{"description":"Profile not found"}},"security":[{"PartnerApiKey":[]},{"PartnerJwtBearerAuth":[]}],"summary":"Get a list of documents for a profile"},"post":{"tags":["AI Customization Documents"],"operationId":"post_ai_customizations_documents_upload","parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"type":"string","pattern":"[1-9][0-9]{0,18}"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["file"],"properties":{"file":{"type":"string","format":"binary"},"description":{"type":"string","maxLength":2000,"example":"Product knowledge base for AI context"},"tags":{"type":"array","items":{"type":"string","enum":["support_material","campaign_material","brand_rules","benchmark_data","product_info"]}}},"type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Document uploaded and revision created with extraction pending","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileDocumentResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":400,"detail":"Bad Request"}}}},"401":{"description":"Authorization error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"404":{"description":"Profile not found"},"422":{"description":"Validation failed"}},"security":[{"PartnerApiKey":[]},{"PartnerJwtBearerAuth":[]}],"summary":"Upload a document to a profile"}},"/api/ai-customizations/v1/profiles/{profile_id}/documents/{document_id}":{"get":{"tags":["AI Customization Documents"],"operationId":"get_ai_customizations_documents_get","parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"type":"integer","maximum":9223372036854776000,"minimum":1,"pattern":"[1-9][0-9]{0,18}"}},{"name":"document_id","in":"path","required":true,"schema":{"type":"integer","maximum":9223372036854776000,"minimum":1,"pattern":"[1-9][0-9]{0,18}"}}],"responses":{"200":{"description":"Document details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileDocumentResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":400,"detail":"Bad Request"}}}},"401":{"description":"Authorization error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"404":{"description":"Profile or document not found"}},"security":[{"PartnerApiKey":[]},{"PartnerJwtBearerAuth":[]}],"summary":"Get document by id"},"delete":{"tags":["AI Customization Documents"],"operationId":"delete_ai_customizations_documents_delete","parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"type":"integer","maximum":9223372036854776000,"minimum":1,"pattern":"[1-9][0-9]{0,18}"}},{"name":"document_id","in":"path","required":true,"schema":{"type":"integer","maximum":9223372036854776000,"minimum":1,"pattern":"[1-9][0-9]{0,18}"}}],"responses":{"204":{"description":"Document was successfully deleted (204 No Content)."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":400,"detail":"Bad Request"}}}},"401":{"description":"Authorization error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"404":{"description":"Profile or document not found"}},"security":[{"PartnerApiKey":[]},{"PartnerJwtBearerAuth":[]}],"summary":"Delete document by id"},"patch":{"tags":["AI Customization Documents"],"operationId":"patch_ai_customizations_documents_update","parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"type":"integer","maximum":9223372036854776000,"minimum":1,"pattern":"[1-9][0-9]{0,18}"}},{"name":"document_id","in":"path","required":true,"schema":{"type":"integer","maximum":9223372036854776000,"minimum":1,"pattern":"[1-9][0-9]{0,18}"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDocumentRequest"}}}},"responses":{"200":{"description":"Updated document details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileDocumentResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":400,"detail":"Bad Request"}}}},"401":{"description":"Authorization error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"404":{"description":"Profile or document not found"},"422":{"description":"Validation failed"}},"security":[{"PartnerApiKey":[]},{"PartnerJwtBearerAuth":[]}],"summary":"Update document by id"}},"/api/ai-customizations/v1/profiles/{profile_id}/documents/{document_id}/download":{"get":{"tags":["AI Customization Documents"],"operationId":"get_ai_customizations_documents_download","parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"type":"integer","maximum":9223372036854776000,"minimum":1,"pattern":"[1-9][0-9]{0,18}"}},{"name":"document_id","in":"path","required":true,"schema":{"type":"integer","maximum":9223372036854776000,"minimum":1,"pattern":"[1-9][0-9]{0,18}"}}],"responses":{"200":{"description":"Presigned S3 URL for downloading the document file","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentDownloadUrlResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":400,"detail":"Bad Request"}}}},"401":{"description":"Authorization error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"404":{"description":"Profile, document, or revision not found"}},"security":[{"PartnerApiKey":[]},{"PartnerJwtBearerAuth":[]}],"summary":"Get a presigned download URL for a document"}},"/api/ai-customizations/v1/profiles/{profile_id}/instructions":{"get":{"tags":["AI Customization Instructions"],"operationId":"get_ai_customizations_instructions_list","parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"type":"integer","maximum":9223372036854776000,"minimum":1,"pattern":"[1-9][0-9]{0,18}"}}],"responses":{"200":{"description":"List of custom instructions for the profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomInstructionListResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":400,"detail":"Bad Request"}}}},"401":{"description":"Authorization error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":404,"detail":"Not Found"}}}}},"security":[{"PartnerApiKey":[]},{"PartnerJwtBearerAuth":[]}],"summary":"Get a list of custom instructions for a profile"},"post":{"tags":["AI Customization Instructions"],"operationId":"post_ai_customizations_instructions_create","parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"type":"integer","maximum":9223372036854776000,"minimum":1,"pattern":"[1-9][0-9]{0,18}"},"example":1}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomInstructionRequest"}}}},"responses":{"201":{"description":"Custom instruction created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomInstructionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":400,"detail":"Bad Request"}}}},"401":{"description":"Authorization error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":404,"detail":"Not Found"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://symfony.com/errors/validation","title":"Validation Failed","status":422,"detail":"assign_to_all_accounts: This value should be of type bool.","violations":[{"propertyPath":"assign_to_all_accounts","title":"This value should be of type bool.","template":"This value should be of type {{ type }}.","parameters":{"{{ type }}":"bool"}}]}}}}},"security":[{"PartnerApiKey":[]},{"PartnerJwtBearerAuth":[]}],"summary":"Create a new custom instruction"}},"/api/ai-customizations/v1/profiles/{profile_id}/instructions/{instruction_id}":{"get":{"tags":["AI Customization Instructions"],"operationId":"get_ai_customizations_instructions_get","parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"type":"integer","maximum":9223372036854776000,"minimum":1,"pattern":"[1-9][0-9]{0,18}"}},{"name":"instruction_id","in":"path","required":true,"schema":{"type":"integer","maximum":9223372036854776000,"minimum":1,"pattern":"[1-9][0-9]{0,18}"}}],"responses":{"200":{"description":"Custom instruction details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomInstructionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":400,"detail":"Bad Request"}}}},"401":{"description":"Authorization error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":404,"detail":"Not Found"}}}}},"security":[{"PartnerApiKey":[]},{"PartnerJwtBearerAuth":[]}],"summary":"Get custom instruction by id"},"delete":{"tags":["AI Customization Instructions"],"operationId":"delete_ai_customizations_instructions_delete","parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"type":"integer","maximum":9223372036854776000,"minimum":1,"pattern":"[1-9][0-9]{0,18}"}},{"name":"instruction_id","in":"path","required":true,"schema":{"type":"integer","maximum":9223372036854776000,"minimum":1,"pattern":"[1-9][0-9]{0,18}"}}],"responses":{"204":{"description":"Custom Instruction was successfully deleted (204 No Content)."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":400,"detail":"Bad Request"}}}},"401":{"description":"Authorization error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":404,"detail":"Not Found"}}}}},"security":[{"PartnerApiKey":[]},{"PartnerJwtBearerAuth":[]}],"summary":"Delete custom instruction by id"},"patch":{"tags":["AI Customization Instructions"],"operationId":"patch_ai_customizations_instructions_update","parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"type":"integer","maximum":9223372036854776000,"minimum":1,"pattern":"[1-9][0-9]{0,18}"}},{"name":"instruction_id","in":"path","required":true,"schema":{"type":"integer","maximum":9223372036854776000,"minimum":1,"pattern":"[1-9][0-9]{0,18}"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCustomInstructionRequest"}}}},"responses":{"200":{"description":"Profile details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomInstructionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":400,"detail":"Bad Request"}}}},"401":{"description":"Authorization error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":404,"detail":"Not Found"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://symfony.com/errors/validation","title":"Validation Failed","status":422,"detail":"assign_to_all_accounts: This value should be of type bool.","violations":[{"propertyPath":"assign_to_all_accounts","title":"This value should be of type bool.","template":"This value should be of type {{ type }}.","parameters":{"{{ type }}":"bool"}}]}}}}},"security":[{"PartnerApiKey":[]},{"PartnerJwtBearerAuth":[]}],"summary":"Update custom instruction by id"}},"/api/ai-customizations/v1/profiles/{id}/accounts":{"patch":{"tags":["AI Customization Profiles"],"operationId":"patch_ai_customizations_profiles_assign_accounts","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","maximum":9223372036854776000,"minimum":1,"pattern":"[1-9][0-9]{0,18}"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignAccountsToProfileRequest"}}}},"responses":{"204":{"description":"Accounts successfully assigned to profile"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":400,"detail":"Bad Request"}}}},"401":{"description":"Authorization error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"403":{"description":"One or more accounts are invalid or do not belong to this reseller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":403,"detail":"One or more accounts are invalid or do not belong to this reseller"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":404,"detail":"Not Found"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://symfony.com/errors/validation","title":"Validation Failed","status":422,"detail":"assign_to_all_accounts: This value should be of type bool.","violations":[{"propertyPath":"assign_to_all_accounts","title":"This value should be of type bool.","template":"This value should be of type {{ type }}.","parameters":{"{{ type }}":"bool"}}]}}}}},"security":[{"PartnerApiKey":[]},{"PartnerJwtBearerAuth":[]}],"summary":"Assign child accounts to a profile"}},"/api/child-account-snapshots/v1/status":{"get":{"tags":["Child Account Snapshots"],"summary":"Get a list of account cloning statuses","operationId":"get_child_account_snapshots_get_list","parameters":[{"name":"status","in":"query","description":"Filter by status. Supports multiple comma-separated values (e.g., in_progress,success)","required":false,"schema":{"type":"string","default":null,"example":"in_progress,success","nullable":true}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1,"maximum":1000000000,"minimum":1}},{"name":"per_page","in":"query","description":"Items per page","required":false,"schema":{"type":"integer","default":20,"maximum":1000,"minimum":1}}],"responses":{"200":{"description":"List of account cloning statuses","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountCloningStatusListResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":400,"detail":"Bad Request"}}}},"401":{"description":"Authorization error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":404,"detail":"Not Found"}}}}},"security":[{"PartnerApiKey":[]},{"PartnerJwtBearerAuth":[]}]}},"/api/child-account-snapshots/v1/":{"get":{"tags":["Child Account Snapshots"],"summary":"Get a list of snapshots","operationId":"get_child_account_snapshots_list_snapshot_by_reseller","parameters":[{"name":"next_cursor","in":"query","description":"Pagination cursor token for the next page of results. Use the value from the previous response's next_cursor.","required":false,"schema":{"type":"string","default":""}},{"name":"limit","in":"query","description":"Number of snapshots per page.","required":false,"schema":{"type":"integer","default":25,"maximum":100,"minimum":1}},{"name":"name","in":"query","description":"Filter snapshots by name.","required":false,"schema":{"type":"string","default":null,"nullable":true}}],"responses":{"200":{"description":"List all snapshots of reseller accounts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AM2GetSnapshotsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":400,"detail":"Bad Request"}}}},"401":{"description":"Authorization error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":404,"detail":"Not Found"}}}}},"security":[{"PartnerApiKey":[]},{"PartnerJwtBearerAuth":[]}]},"post":{"tags":["Child Account Snapshots"],"summary":"Create a new snapshot","operationId":"post_child_account_snapshots_create_snapshot","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AM2CreateSnapshotRequest"}}}},"responses":{"201":{"description":"Snapshot was created successfully."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":400,"detail":"Bad Request"}}}},"401":{"description":"Authorization error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":404,"detail":"Not Found"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://symfony.com/errors/validation","title":"Validation Failed","status":422,"detail":"assign_to_all_accounts: This value should be of type bool.","violations":[{"propertyPath":"assign_to_all_accounts","title":"This value should be of type bool.","template":"This value should be of type {{ type }}.","parameters":{"{{ type }}":"bool"}}]}}}}},"security":[{"PartnerApiKey":[]},{"PartnerJwtBearerAuth":[]}]}},"/api/child-account-snapshots/v1/{snapshotId}":{"delete":{"tags":["Child Account Snapshots"],"summary":"Delete snapshot by id","operationId":"delete_child_account_snapshots_delete_snapshot","parameters":[{"name":"snapshotId","in":"path","required":true,"schema":{"type":"string","pattern":"[1-9][0-9]{0,18}"}}],"responses":{"200":{"description":"Snapshot was successfully deleted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":400,"detail":"Bad Request"}}}},"401":{"description":"Authorization error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"},"example":{"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"An error occurred","status":404,"detail":"Not Found"}}}}},"security":[{"PartnerApiKey":[]},{"PartnerJwtBearerAuth":[]}]}},"/api/child-accounts/v1/":{"get":{"tags":["Child Accounts"],"operati

# --- truncated at 32 KB (79 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/openapi/activecampaign-partners-api-openapi.json