Start Campaign Api

curl --request PUT \
  --url https://services.meetchase.ai/api/v1/campaigns/{campaign_id}/start \
  --header 'X-API-Key: <api-key>'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Campaigns

Start Campaign

Initiates a specified campaign, marking it as active and beginning the exchanges.

organisation_id (int): The ID of the organisation under which the campaign is registered.
campaign_id (int): The unique identifier of the campaign to be started.

Returns a confirmation message indicating that the campaign has been successfully started and will begin its operations imminently.

400 Bad Request: If the campaign cannot be started due to missing or invalid campaign settings.
403 Forbidden: If the user making the request does not have the necessary permissions to start the campaign.
404 Not Found: The campaign does not belong to the specified organisation.

PUT

api

campaigns

{campaign_id}

start

Start Campaign Api

curl --request PUT \
  --url https://services.meetchase.ai/api/v1/campaigns/{campaign_id}/start \
  --header 'X-API-Key: <api-key>'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

X-API-Key

string

header

required

Key used to authenticate user API requests.

campaign_id

integer

required

Successful Response