The Add users to a campaign endpoint assigns users to the specified Dialer campaign.

Requirements: Base URL, Authentication, Error codes

What this does

When you send an Add users to a campaign request, Voiso assigns the specified users to the campaign and returns the users that were added.

Endpoint


POST /api/v4/campaigns/{campaign_id}/users

Path parameters

campaign_id
The unique identifier of the campaign.

Request body

Required fields:

user_ids
List of user IDs to assign to the campaign.

Notes:

You can include up to 100 user IDs in a single request.

Related endpoints

Get a campaign ID: Get list of campaigns
Get user IDs: Get list of users
Verify current assignments: Get users assigned to a campaign

Example request

curl -X POST "https://{cluster_id}.voiso.com/api/v4/campaigns/1/users" \
  -H "Authorization: Bearer <contact_center_api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "user_ids": [42, 128]
  }'

Response

If successful, the API returns added_users.

{
  "added_users": [
    {
      "id": 42,
      "name": "Jane Doe",
      "email": "jane.doe@companyname.com"
    }
  ]
}

Troubleshooting

401 Unauthorized

Returned if the API key is missing or invalid.

403 Forbidden

Returned if the API key does not have access to Campaigns resources.

404 Not found

Returned if the campaign does not exist or is not accessible.

409 Conflict

Returned if the request conflicts with the current state of the campaign.

422 Unprocessable Entity

Returned when request validation fails (for example, user_ids is missing or exceeds the maximum allowed items).

429 Too many requests

Returned if requests are rate limited.

200OK

401Unauthorized

403Forbidden

404Not found

409Conflict

422Unprocessable Entity

429Too many requests