I-i-stem

POST /v1/external/campaigns/{agent_id}

Changed on

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

Request

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

  • 15c9445bbca8Revision changes
    • breaking

      the / request property's min was increased to 1.00

    • breaking

      the / request property's minItems was increased to 1

    • warning

      the request property's maxLength was set to 120

    • warning

      the / request property's max was set to 5.00

    • warning

      the / request property's max was set to 1440.00

  • 888e48b1600eRevision changes
    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the required property to the response with the status