v1
latestOpenAPI 3.0.32026-07-246376162.1 KBCampaigns
Add users to a campaign
Assigns users to the specified campaign.
post/api/v4/campaigns/{campaign_id}/users
Path parameters
campaign_idinteger required
Example:1
The unique identifier of the campaign.
Request body
Example request
{
"user_ids": [
42,
128
]
}Response
OK
Example response
{
"added_users": [
{
"id": 1,
"name": "Jane Doe",
"email": "jane.doe@companyname.com",
"sip_account": "jane.doe@contactcenter.com",
"extension": "102",
"caller_id": "12025550123",
"employee_id": "E-482",
"timezone": "America/New_York",
"security_access_group": {
"id": 3,
"name": "Boarding"
},
"teams": [
{
"id": 3,
"name": "Multilingual Support"
}
],
"supervised_teams": [
{
"id": 3,
"name": "Multilingual Support"
}
],
"queues": [
{
"id": 1,
"name": "Technical Support"
}
],
"supervised_queues": [
{
"id": 1,
"name": "Technical Support"
}
],
"webrtc_ringtone": {
"type": "ringtone",
"name": "Bells (Default)"
},
"channels": [
"voice",
"chat",
"whatsapp"
],
"channel_group_capacity": {
"chat": 5,
"instant": 3
},
"channel_profiles": [
{
"id": 12,
"channel": "whatsapp",
"identifier": "18885658889",
"name": "WhatsApp Main (18885658889)"
}
],
"speech_language": "en",
"skills": [
{
"skill": {
"id": 1,
"name": "Sales",
"created_at": "2026-01-15T10:30:00.123000Z",
"updated_at": "2026-01-20T14:15:00.456000Z"
},
"value": 5
}
],
"status": "available",
"created_at": "2025-11-11T12:00:00.216000Z",
"updated_at": "2025-11-11T12:00:00.216000Z",
"deleted_at": "2025-11-11T12:00:00.216000Z"
}
]
}