Campaign

Update a campaign

Changed on

Updates the details of an existing campaign and returns the updated campaign.

put/campaigns/{id}

Request

  • Base URL
    https://api.voipbin.net/v1.0
  • URL
    https://api.voipbin.net/v1.0/campaigns/{id}
  • Auth
    none declared

Path parameters

idstring required

ID of the campaign

Request body

namestring

Updated name of the campaign. Omit to leave unchanged.

detailstring

Updated details of the campaign. Omit to leave unchanged.

type'call' | 'flow'

Type of campaign.

service_levelinteger

Updated service level of the campaign. Omit to leave unchanged.

end_handle'stop' | 'continue'

Behavior of the campaign after outdial has no more targets.

Example request

{
  "type": "call",
  "end_handle": "stop"
}

Response

idstring uuid

The unique identifier of the campaign.

customer_idstring uuid

The unique identifier of the customer. Returned from the GET /customers response.

type'call' | 'flow'

Type of campaign.

namestring

Display name of the campaign.

detailstring

Additional details about the campaign.

status'stop' | 'stopping' | 'run'

Status of the campaign.

service_levelinteger

Target service level percentage.

end_handle'stop' | 'continue'

Behavior of the campaign after outdial has no more targets.

outplan_idstring uuid

The unique identifier of the outplan. Returned from the POST /outplans or GET /outplans response.

outdial_idstring uuid

The unique identifier of the outdial. Returned from the POST /outdials or GET /outdials response.

queue_idstring uuid

The unique identifier of the queue. Returned from the POST /queues or GET /queues response.

next_campaign_idstring uuid

The unique identifier of the next campaign to execute after this one completes. Returned from the POST /campaigns or GET /campaigns response.

tm_createstring date-time

Timestamp when the campaign was created.

tm_updatestring date-time

Timestamp when the campaign was last updated.

tm_deletestring date-time

Timestamp when the campaign was deleted.

Example response

{
  "id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "type": "call",
  "name": "Q1 Outbound Campaign",
  "detail": "Quarterly customer outreach campaign",
  "status": "run",
  "service_level": 80,
  "end_handle": "stop",
  "actions": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "next_id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "talk",
      "tm_execute": "2026-01-15T09:30:00.000000Z"
    }
  ],
  "outplan_id": "2b3c4d5e-6f7a-8901-bcde-f12345678901",
  "outdial_id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  "queue_id": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
  "next_campaign_id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-15T09:30:00.000000Z",
  "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Changes

  • d15cd059ccdbRevision changes
    • breaking

      added to the request property allOf list

    • breaking

      added to the request property allOf list

    • breaking

      removed the enum value call of the request property

    • breaking

      removed the enum value continue of the request property

    • breaking

      removed the enum value flow of the request property

    • breaking

      removed the enum value stop of the request property

    • breaking

      the request property type changed from string to no type

    • breaking

      the request property type changed from string to no type

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional