Creates a draft outbound campaign for the specified agent. The agent must belong to your organization.

post/v1/external/campaigns/{agent_id}

Path parameters

agent_idstring uuid required

The UUID of the AI agent that owns the campaign.

Request body

namestring required

Campaign name. Maximum 120 characters.

Example request

{
  "retry_config": {
    "max_retries": 2,
    "retry_delay_minutes": 30,
    "retry_on": [
      "UNANSWERED",
      "REJECTED",
      "VOICEMAIL"
    ]
  }
}

Response

Campaign created successfully

messagestring required

Changes

Changed in 4 of the 17 revisions of this API.455

  • 15c9445bbca823See the full diff
    • the retry_config/max_retries request property's min was increased to 1.00

      request-property-min-increased

    • the retry_config/retry_on request property's minItems was increased to 1

      request-property-min-items-increased

    • the name request property's maxLength was set to 120

      request-property-max-length-set

    • the retry_config/max_retries request property's max was set to 5.00

      request-property-max-set

    • the retry_config/retry_delay_minutes request property's max was set to 1440.00

      request-property-max-set

  • 888e48b1600e124See the full diff
    • removed the required property campaign_id from the response with the 201 status

      response-required-property-removed

    • removed the request property cps

      request-property-removed

    • removed the request property metadata

      request-property-removed

    • added the new optional request property retry_config/max_retries

      new-optional-request-property

    • added the new optional request property retry_config/retry_delay_minutes

      new-optional-request-property

    • added the new optional request property retry_config/retry_on

      new-optional-request-property

    • added the required property data to the response with the 201 status

      response-required-property-added

    • endpoint added

      endpoint-added

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 33 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog