campaigns

Remove users from a campaign

Changed on

Removes one or more individual users from a campaign. The user IDs to remove are provided as a query parameter array (to_Users). Removed users will no longer receive campaign calls. The response reports which users were successfully removed (Users_deleted_from_queue) and which were not assigned (Users_not_in_queue).

Permission: No specific permission required. A valid API key is sufficient.

delete/campaigns/call/{campaignscalllistuuid}/users

Request

  • Base URL
    https://public-api.ringover.com/v2
  • URL
    https://public-api.ringover.com/v2/campaigns/call/{campaignscalllistuuid}/users
  • Auth
    API key in header Authorization

Path parameters

campaignscalllistuuidstring uuid required

The UUID of the campaign (e.g., 1a7a5639-3818-4b0e-9285-f6b3795f8db4). Use GET /campaigns/call to discover campaign UUIDs.

Query parameters

to_Usersinteger[]

Array of user IDs to remove from the campaign.

Response

Successful operation

Users_deleted_from_queueinteger[]
Users_not_in_queueinteger[]

Changes