ActiveCampaign

ActiveCampaign AI Customization Profiles API

Manage AI customization profiles.

GitHub OpenAPI

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/ai-customizations/v1/profiles List AI customization profiles · Get a list of AI customization profiles #
Ask an LLM
“What AI customization profiles have I set up in ActiveCampaign?”
“Can I see all the AI profiles available to assign to child accounts?”
Tell an agent
List my AI customization profiles.
Show every AI customization profile in the account.
POST /api/ai-customizations/v1/profiles Create an AI customization profile · Create a new AI customization profile #
Ask an LLM
“How do I create a new AI customization profile?”
“What do I need to supply to start a new AI profile?”
Tell an agent
Create an AI customization profile named {name}.
Set up a new AI profile called {name} for our agency clients.
GET /api/ai-customizations/v1/profiles/{id} Retrieve an AI customization profile · Get profile by id #
Ask an LLM
“How do I look up one AI customization profile by ID?”
“What settings does a single AI profile contain?”
Tell an agent
Get AI customization profile {id}.
Show the details of AI profile {id}.
DELETE /api/ai-customizations/v1/profiles/{id} Delete an AI customization profile · Delete profile by id #
Ask an LLM
“How do I delete an AI customization profile I no longer use?”
“Can I remove an AI profile by its ID?”
Tell an agent destructive · confirm first
Delete AI customization profile {id}.
Remove AI profile {id} permanently.
PATCH /api/ai-customizations/v1/profiles/{id} Rename an AI customization profile · Update profile by id #
Ask an LLM
“How do I rename an existing AI customization profile?”
“Can I update the name on an AI profile after creating it?”
Tell an agent
Rename AI customization profile {id} to {name}.
Update AI profile {id} so its name is {name}.
GET /api/ai-customizations/v1/profiles/child-accounts/{childAccountId} Get the AI profile assigned to a child account · Get the AI customization profile assigned to a child account #
Ask an LLM
“Which AI customization profile is a given child account using?”
“Can I check a child account's assigned AI profile?”
Tell an agent
Get the AI profile assigned to child account {childAccountId}.
Tell me which AI customization profile child account {childAccountId} uses.
PATCH /api/ai-customizations/v1/profiles/{id}/accounts Assign child accounts to an AI profile · Assign child accounts to a profile #
Ask an LLM
“How do I assign several child accounts to one AI customization profile?”
“Can I apply an AI profile to all of my child accounts at once?”
Tell an agent
Assign child accounts {account_ids} to AI profile {id}.
Apply AI profile {id} to every child account with assign-to-all set to {assign_to_all_accounts}.

Documentation

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

Specifications

⚙
OpenAPI
https://artifacts.apis.io/activecampaign/openapi/activecampaign-ai-customization-profiles-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/activecampaign/json-schema/activecampaign-assign-accounts-to-profile-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/activecampaign/json-schema/activecampaign-profile-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/activecampaign/json-schema/activecampaign-child-account-profile-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/activecampaign/json-schema/activecampaign-profile-list-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/activecampaign/json-schema/activecampaign-update-profile-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/activecampaign/json-schema/activecampaign-create-profile-request-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/activecampaign:activecampaign-ai-customization-profiles-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

activecampaign-ai-customization-profiles-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Partners AI Customization Profiles 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
tags:
- name: AI Customization Profiles
  description: Manage AI customization profiles.
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'
                    type:
                    - object
                    - 'null'
                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/{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
components:
  schemas:
    CreateProfileResponse:
      required:
      - id
      properties:
        id:
          type: integer
      type: object
      additionalProperties: false
    CreateProfileRequest:
      required:
      - name
      properties:
        name:
          type: string
          maxLength: 255
          minLength: 1
          example: Gyms
      type: object
      additionalProperties: false
    ChildAccountData:
      required:
      - id
      - created_at
      - updated_at
      properties:
        id:
          type: integer
        reseller_id:
          type:
          - integer
          - 'null'
        account_name:
          type:
          - string
          - 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      type: object
      additionalProperties: false
    ChildAccountProfileResponse:
      required:
      - id
      - reseller_id
      - name
      - created_at
      - updated_at
      properties:
        id:
          type: integer
        reseller_id:
          type: integer
        name:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      type: object
      additionalProperties: false
    UpdateProfileRequest:
      required:
      - name
      properties:
        name:
          type: string
          maxLength: 255
          minLength: 1
          example: Gyms and fitness centers
      type: object
      additionalProperties: false
    UnauthorizedResponse:
      description: Unauthorized
      example:
        error: Unauthorized
        message: Invalid credentials
    AssignAccountsToProfileRequest:
      description: You cannot provide non-empty accountIds and set assignToAllAccounts to true at the same time.
      properties:
        account_ids:
          description: List of account IDs to assign
          type: array
          items:
            type: integer
            maximum: 9223372036854776000
            minimum: 1
          default: []
        reassign:
          type: boolean
          default: false
        assign_to_all_accounts:
          type: boolean
          default: false
      type: object
      oneOf:
      - required:
        - account_ids
        properties:
          account_ids:
            type: array
            items:
              type: integer
              minimum: 1
            minItems: 1
          reassign:
            type: boolean
        additionalProperties: false
      - required:
        - assign_to_all_accounts
        properties:
          reassign:
            type: boolean
          assign_to_all_accounts:
            type: boolean
        additionalProperties: false
      additionalProperties: false
    ProfileListResponse:
      required:
      - profiles
      properties:
        profiles:
          oneOf:
          - type: array
            items:
              $ref: '#/components/schemas/ProfileResponse'
          - type: object
            additionalProperties:
              $ref: '#/components/schemas/ProfileResponse'
      type: object
      additionalProperties: false
    ProfileResponse:
      required:
      - id
      - reseller_id
      - name
      - created_at
      - updated_at
      - assigned_accounts_count
      properties:
        id:
          type: integer
        reseller_id:
          type: integer
        name:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        assigned_accounts_count:
          type: integer
        assigned_accounts:
          default: null
          oneOf:
          - type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/ChildAccountData'
          - type:
            - object
            - 'null'
            additionalProperties:
              $ref: '#/components/schemas/ChildAccountData'
      type: object
      additionalProperties: false
    ApiViolation:
      required:
      - propertyPath
      - title
      - template
      - parameters
      properties:
        propertyPath:
          type: string
        title:
          type: string
        template:
          type: string
        parameters:
          oneOf:
          - oneOf:
            - type: array
              items: {}
            - type: object
              additionalProperties: {}
          - type: object
            additionalProperties:
              type: string
      type: object
      additionalProperties: true
    ApiErrorResponse:
      required:
      - type
      - title
      - status
      - detail
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        violations:
          default: null
          oneOf:
          - type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/ApiViolation'
          - type:
            - object
            - 'null'
            additionalProperties:
              $ref: '#/components/schemas/ApiViolation'
      type: object
      additionalProperties: true
  securitySchemes:
    PartnerApiKey:
      type: apiKey
      description: API Token Authorization from Partner Portal
      name: api-key
      in: header
    PartnerJwtBearerAuth:
      type: http
      description: JWT Authorization header using the Partner JWT token.
      bearerFormat: JWT
      scheme: bearer