Agent Management
Authorizations
AuthorizationstringRequired
Provide the token that is returned upon login
Path parameters
workspaceIdstringRequired
Query parameters
limitinteger · min: 1 · max: 100OptionalDefault:
Limits the number of results to return
10pageTokenstring · max: 8000Optional
Pagination token that keeps of track of the current position in the list
reversebooleanOptionalDefault:
Order in which to retrieve the results
falsesortBystring · enumOptionalPossible values:
Sort by field specified
namestringOptional
Filter by agent name
emailstringOptional
Filter by agent email
roleIdsstring · uuid[]Optional
Filter by agent role ids
lastStatusActivitySincestringOptional
To filter agents by their last status change since.
lastStatusActivityUptostringOptional
To filter agents by their last status change activity time.
agentIdsstring · uuid[]Optional
To find specific agents by their ids. If this is specified, other parameters are ignored.
Responses
200
OK
application/json
Responseall of
404
Workspace not found
application/json
get
/workspaces/{workspaceId}/agentsGET /workspaces/{workspaceId}/agents HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"results": [
{
"id": "text",
"status": "active",
"statusBeforeOffline": "active",
"name": "text",
"overrideName": true,
"workspaceId": "text",
"type": "user",
"userEmails": [
"text"
],
"bio": "text",
"avatarUrl": "text",
"dropVms": [
null
],
"tagCount": 1,
"wrapUpTime": 1,
"lastAssignedAt": "2025-11-28T02:12:07.730Z",
"lastSetToAwayAt": "2025-11-28T02:12:07.730Z",
"teams": [
{
"id": "text",
"name": "text",
"memberSince": "2025-11-28T02:12:07.730Z",
"activeMemberCount": 1,
"pendingMemberCount": 1
}
],
"workload": {
"id": "text",
"workload": {
"messaging": 1,
"email": 1
},
"rule": {
"id": "text",
"workspaceId": "text",
"name": "text",
"description": "text",
"default": true,
"capacity": {
"messaging": 1,
"email": 1
},
"assignedAgentIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"createdAt": "text",
"updatedAt": "text"
},
"ruleId": "text",
"updatedAt": "2025-11-28T02:12:07.730Z"
},
"createdAt": "2025-11-28T02:12:07.730Z",
"updatedAt": "2025-11-28T02:12:07.730Z",
"availability": {
"status": "active",
"activity": "available",
"activityTtl": 1,
"activityText": "text",
"lastStatusSet": "text",
"lastActivitySet": "text",
"updatedAt": "2025-11-28T02:12:07.730Z"
},
"timezone": "text",
"defaultCountryCode": "text",
"defaultCallerId": "text",
"forwardNumber": {
"enabled": true,
"number": "text",
"maskCaller": true
},
"transcriptionLocale": "ar-AE",
"roles": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "organization",
"workspaces": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
],
"user": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"avatarUrl": "text",
"defaultEmail": "text",
"phoneNumber": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"weeklySchedule": {
"monday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"tuesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"wednesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"thursday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"friday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"saturday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"sunday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
}
},
"holidays": [
{
"name": "text",
"day": 1,
"month": 1
}
],
"assignedSkills": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"valueType": "single",
"selectedValues": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"value": "text",
"icon": "text"
}
]
}
],
"defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
"outOfOfficeResponse": "text"
}
],
"nextPageToken": "text",
"total": 1
}Create a new agent with specified details like name, role, and basic bio.
Authorizations
AuthorizationstringRequired
Provide the token that is returned upon login
Path parameters
workspaceIdstringRequired
Body
one ofOptional
or
or
Responses
201
Created
application/json
404
Workspace not found
application/json
409
Agent already exists
application/json
422
Invalid agent
application/json
post
/workspaces/{workspaceId}/agentsPOST /workspaces/{workspaceId}/agents HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 730
{
"name": "text",
"bio": "text",
"type": "user",
"userId": "123e4567-e89b-12d3-a456-426614174000",
"teamIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"timezone": "text",
"defaultCountryCode": "text",
"weeklySchedule": {
"monday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"tuesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"wednesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"thursday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"friday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"saturday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"sunday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
}
},
"holidays": [
{
"name": "text",
"day": 1,
"month": 1
}
]
}{
"id": "text",
"status": "active",
"statusBeforeOffline": "active",
"name": "text",
"overrideName": true,
"workspaceId": "text",
"type": "user",
"userEmails": [
"text"
],
"bio": "text",
"avatarUrl": "text",
"dropVms": [
null
],
"tagCount": 1,
"wrapUpTime": 1,
"lastAssignedAt": "2025-11-28T02:12:07.730Z",
"lastSetToAwayAt": "2025-11-28T02:12:07.730Z",
"teams": [
{
"id": "text",
"name": "text",
"memberSince": "2025-11-28T02:12:07.730Z",
"activeMemberCount": 1,
"pendingMemberCount": 1
}
],
"workload": {
"id": "text",
"workload": {
"messaging": 1,
"email": 1
},
"rule": {
"id": "text",
"workspaceId": "text",
"name": "text",
"description": "text",
"default": true,
"capacity": {
"messaging": 1,
"email": 1
},
"assignedAgentIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"createdAt": "text",
"updatedAt": "text"
},
"ruleId": "text",
"updatedAt": "2025-11-28T02:12:07.730Z"
},
"createdAt": "2025-11-28T02:12:07.730Z",
"updatedAt": "2025-11-28T02:12:07.730Z",
"availability": {
"status": "active",
"activity": "available",
"activityTtl": 1,
"activityText": "text",
"lastStatusSet": "text",
"lastActivitySet": "text",
"updatedAt": "2025-11-28T02:12:07.730Z"
},
"timezone": "text",
"defaultCountryCode": "text",
"defaultCallerId": "text",
"forwardNumber": {
"enabled": true,
"number": "text",
"maskCaller": true
},
"transcriptionLocale": "ar-AE",
"roles": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "organization",
"workspaces": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
],
"user": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"avatarUrl": "text",
"defaultEmail": "text",
"phoneNumber": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"weeklySchedule": {
"monday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"tuesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"wednesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"thursday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"friday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"saturday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"sunday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
}
},
"holidays": [
{
"name": "text",
"day": 1,
"month": 1
}
],
"assignedSkills": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"valueType": "single",
"selectedValues": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"value": "text",
"icon": "text"
}
]
}
],
"defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
"outOfOfficeResponse": "text"
}Lists all agents for a workspace returning only minimal fields for each agent.
Authorizations
AuthorizationstringRequired
Provide the token that is returned upon login
Path parameters
workspaceIdstringRequired
Responses
200
OK
application/json
get
/workspaces/{workspaceId}/all-agentsGET /workspaces/{workspaceId}/all-agents HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
OK
{
"results": [
{
"id": "text",
"status": "active",
"activity": "available",
"name": "text",
"avatarUrl": "text",
"createdAt": "2025-11-28T02:12:07.730Z"
}
]
}Retrieve information about a specific agent, including their name, bio, status.
Authorizations
AuthorizationstringRequired
Provide the token that is returned upon login
Path parameters
workspaceIdstringRequired
agentIdstringRequired
Responses
200
OK
application/json
404
Agent or workspace not found
application/json
get
/workspaces/{workspaceId}/agents/{agentId}GET /workspaces/{workspaceId}/agents/{agentId} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "text",
"status": "active",
"statusBeforeOffline": "active",
"name": "text",
"overrideName": true,
"workspaceId": "text",
"type": "user",
"userEmails": [
"text"
],
"bio": "text",
"avatarUrl": "text",
"dropVms": [
null
],
"tagCount": 1,
"wrapUpTime": 1,
"lastAssignedAt": "2025-11-28T02:12:07.730Z",
"lastSetToAwayAt": "2025-11-28T02:12:07.730Z",
"teams": [
{
"id": "text",
"name": "text",
"memberSince": "2025-11-28T02:12:07.730Z",
"activeMemberCount": 1,
"pendingMemberCount": 1
}
],
"workload": {
"id": "text",
"workload": {
"messaging": 1,
"email": 1
},
"rule": {
"id": "text",
"workspaceId": "text",
"name": "text",
"description": "text",
"default": true,
"capacity": {
"messaging": 1,
"email": 1
},
"assignedAgentIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"createdAt": "text",
"updatedAt": "text"
},
"ruleId": "text",
"updatedAt": "2025-11-28T02:12:07.730Z"
},
"createdAt": "2025-11-28T02:12:07.730Z",
"updatedAt": "2025-11-28T02:12:07.730Z",
"availability": {
"status": "active",
"activity": "available",
"activityTtl": 1,
"activityText": "text",
"lastStatusSet": "text",
"lastActivitySet": "text",
"updatedAt": "2025-11-28T02:12:07.730Z"
},
"timezone": "text",
"defaultCountryCode": "text",
"defaultCallerId": "text",
"forwardNumber": {
"enabled": true,
"number": "text",
"maskCaller": true
},
"transcriptionLocale": "ar-AE",
"roles": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "organization",
"workspaces": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
],
"user": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"avatarUrl": "text",
"defaultEmail": "text",
"phoneNumber": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"weeklySchedule": {
"monday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"tuesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"wednesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"thursday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"friday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"saturday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"sunday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
}
},
"holidays": [
{
"name": "text",
"day": 1,
"month": 1
}
],
"assignedSkills": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"valueType": "single",
"selectedValues": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"value": "text",
"icon": "text"
}
]
}
],
"defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
"outOfOfficeResponse": "text"
}Retrieve the url and form data to post profile avatar directly.
Authorizations
AuthorizationstringRequired
Provide the token that is returned upon login
Path parameters
workspaceIdstringRequired
agentIdstringRequired
Responses
200
OK
application/json
get
/workspaces/{workspaceId}/agents/{agentId}/presigned-uploadGET /workspaces/{workspaceId}/agents/{agentId}/presigned-upload HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
OK
{
"mediaUrl": "text",
"fileId": "123e4567-e89b-12d3-a456-426614174000",
"url": "text",
"formData": {
"policy": "eyAiZXhwaXJhdGlvbiI6ICIyMDE1LTEyLTMwVDEyOjAwOjAwLjAwMFoiLA0KICAiY29uZGl0aW9ucyI6IFsNCiAgICB7ImJ1Y2tldCI6ICJzaWd2NGV4YW",
"x-amz-algorithm": "AWS4-HMAC-SHA256",
"x-amz-credential": "AKIAIOSFODNN7EXAMPLE/20151229/us-east-1/s3/aws4_request",
"x-amz-date": "20151229T000000Z",
"x-amz-signature": "8afdbf4008c03f22c2cd3cdb72e4afbb1f6a588f3255ac628749a66d7f09699e"
},
"expectedFields": [
"text"
]
}Retrieve the url and form data to post audio files directly.
Authorizations
AuthorizationstringRequired
Provide the token that is returned upon login
Path parameters
workspaceIdstringRequired
agentIdstringRequired
Responses
200
OK
application/json
post
/workspaces/{workspaceId}/agents/{agentId}/presigned-upload/audioPOST /workspaces/{workspaceId}/agents/{agentId}/presigned-upload/audio HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
OK
{
"mediaUrl": "text",
"fileId": "123e4567-e89b-12d3-a456-426614174000",
"url": "text",
"formData": {
"policy": "eyAiZXhwaXJhdGlvbiI6ICIyMDE1LTEyLTMwVDEyOjAwOjAwLjAwMFoiLA0KICAiY29uZGl0aW9ucyI6IFsNCiAgICB7ImJ1Y2tldCI6ICJzaWd2NGV4YW",
"x-amz-algorithm": "AWS4-HMAC-SHA256",
"x-amz-credential": "AKIAIOSFODNN7EXAMPLE/20151229/us-east-1/s3/aws4_request",
"x-amz-date": "20151229T000000Z",
"x-amz-signature": "8afdbf4008c03f22c2cd3cdb72e4afbb1f6a588f3255ac628749a66d7f09699e"
},
"expectedFields": [
"text"
]
}Get media download from an agent
Authorizations
AuthorizationstringRequired
Provide the token that is returned upon login
Path parameters
workspaceIdstringRequired
agentIdstringRequired
fileIdstringRequired
Query parameters
redirectbooleanOptional
Responses
200
Return file location
302
Redirect to file location
400
Bad request
application/json
404
The resource is not found
application/json
get
/workspaces/{workspaceId}/agents/{agentId}/media/{fileId}/downloadGET /workspaces/{workspaceId}/agents/{agentId}/media/{fileId}/download HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Modify the details of a specific agent, such as their name, bio, status.
Authorizations
AuthorizationstringRequired
Provide the token that is returned upon login
Path parameters
workspaceIdstringRequired
agentIdstringRequired
Body
namestring · min: 1 · max: 50Optional
biostring · max: 240Optional
statusstring · enumOptionalPossible values:
avatarUrlstringOptional
wrapUpTimeinteger · max: 900Optional
timezonestringOptional
defaultCountryCodestringOptional
defaultCallerIdstringOptional
transcriptionLocalestring · enumOptionalPossible values:
defaultSenderIdstring · uuidOptional
The default Sender Profile to select for this agent when composing a new message.
outOfOfficeResponsestring · max: 1000Optional
Responses
200
Updated
application/json
404
Agent or workspace not found
application/json
422
Invalid agent
application/json
patch
/workspaces/{workspaceId}/agents/{agentId}PATCH /workspaces/{workspaceId}/agents/{agentId} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1088
{
"name": "text",
"bio": "text",
"status": "active",
"avatarUrl": "text",
"dropVms": [
null
],
"wrapUpTime": 1,
"timezone": "text",
"defaultCountryCode": "text",
"defaultCallerId": "text",
"forwardNumber": {
"enabled": true,
"number": "text",
"maskCaller": true
},
"transcriptionLocale": "ar-AE",
"weeklySchedule": {
"monday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"tuesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"wednesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"thursday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"friday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"saturday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"sunday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
}
},
"holidays": [
{
"name": "text",
"day": 1,
"month": 1
}
],
"assignedSkills": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"valueType": "single",
"selectedValues": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"value": "text",
"icon": "text"
}
]
}
],
"defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
"outOfOfficeResponse": "text"
}{
"id": "text",
"status": "active",
"statusBeforeOffline": "active",
"name": "text",
"overrideName": true,
"workspaceId": "text",
"type": "user",
"userEmails": [
"text"
],
"bio": "text",
"avatarUrl": "text",
"dropVms": [
null
],
"tagCount": 1,
"wrapUpTime": 1,
"lastAssignedAt": "2025-11-28T02:12:07.730Z",
"lastSetToAwayAt": "2025-11-28T02:12:07.730Z",
"teams": [
{
"id": "text",
"name": "text",
"memberSince": "2025-11-28T02:12:07.730Z",
"activeMemberCount": 1,
"pendingMemberCount": 1
}
],
"workload": {
"id": "text",
"workload": {
"messaging": 1,
"email": 1
},
"rule": {
"id": "text",
"workspaceId": "text",
"name": "text",
"description": "text",
"default": true,
"capacity": {
"messaging": 1,
"email": 1
},
"assignedAgentIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"createdAt": "text",
"updatedAt": "text"
},
"ruleId": "text",
"updatedAt": "2025-11-28T02:12:07.730Z"
},
"createdAt": "2025-11-28T02:12:07.730Z",
"updatedAt": "2025-11-28T02:12:07.730Z",
"availability": {
"status": "active",
"activity": "available",
"activityTtl": 1,
"activityText": "text",
"lastStatusSet": "text",
"lastActivitySet": "text",
"updatedAt": "2025-11-28T02:12:07.730Z"
},
"timezone": "text",
"defaultCountryCode": "text",
"defaultCallerId": "text",
"forwardNumber": {
"enabled": true,
"number": "text",
"maskCaller": true
},
"transcriptionLocale": "ar-AE",
"roles": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "organization",
"workspaces": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
],
"user": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"avatarUrl": "text",
"defaultEmail": "text",
"phoneNumber": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"weeklySchedule": {
"monday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"tuesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"wednesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"thursday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"friday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"saturday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"sunday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
}
},
"holidays": [
{
"name": "text",
"day": 1,
"month": 1
}
],
"assignedSkills": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"valueType": "single",
"selectedValues": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"value": "text",
"icon": "text"
}
]
}
],
"defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
"outOfOfficeResponse": "text"
}Remove a specific agent from the system, permanently deleting their profile and associated data.
Authorizations
AuthorizationstringRequired
Provide the token that is returned upon login
Path parameters
workspaceIdstringRequired
agentIdstringRequired
Responses
204
Deleted
404
Agent or workspace not found
application/json
delete
/workspaces/{workspaceId}/agents/{agentId}DELETE /workspaces/{workspaceId}/agents/{agentId} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Retrieve information about a specific agent, including their name, bio, status.
Authorizations
AuthorizationstringRequired
Provide the token that is returned upon login
Path parameters
workspaceIdstringRequired
Responses
200
OK
application/json
404
Agent or workspace not found
application/json
get
/workspaces/{workspaceId}/agents/meGET /workspaces/{workspaceId}/agents/me HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "text",
"status": "active",
"statusBeforeOffline": "active",
"name": "text",
"overrideName": true,
"workspaceId": "text",
"type": "user",
"userEmails": [
"text"
],
"bio": "text",
"avatarUrl": "text",
"dropVms": [
null
],
"tagCount": 1,
"wrapUpTime": 1,
"lastAssignedAt": "2025-11-28T02:12:07.730Z",
"lastSetToAwayAt": "2025-11-28T02:12:07.730Z",
"teams": [
{
"id": "text",
"name": "text",
"memberSince": "2025-11-28T02:12:07.730Z",
"activeMemberCount": 1,
"pendingMemberCount": 1
}
],
"workload": {
"id": "text",
"workload": {
"messaging": 1,
"email": 1
},
"rule": {
"id": "text",
"workspaceId": "text",
"name": "text",
"description": "text",
"default": true,
"capacity": {
"messaging": 1,
"email": 1
},
"assignedAgentIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"createdAt": "text",
"updatedAt": "text"
},
"ruleId": "text",
"updatedAt": "2025-11-28T02:12:07.730Z"
},
"createdAt": "2025-11-28T02:12:07.730Z",
"updatedAt": "2025-11-28T02:12:07.730Z",
"availability": {
"status": "active",
"activity": "available",
"activityTtl": 1,
"activityText": "text",
"lastStatusSet": "text",
"lastActivitySet": "text",
"updatedAt": "2025-11-28T02:12:07.730Z"
},
"timezone": "text",
"defaultCountryCode": "text",
"defaultCallerId": "text",
"forwardNumber": {
"enabled": true,
"number": "text",
"maskCaller": true
},
"transcriptionLocale": "ar-AE",
"roles": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "organization",
"workspaces": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
],
"user": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"avatarUrl": "text",
"defaultEmail": "text",
"phoneNumber": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"weeklySchedule": {
"monday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"tuesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"wednesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"thursday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"friday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"saturday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"sunday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
}
},
"holidays": [
{
"name": "text",
"day": 1,
"month": 1
}
],
"assignedSkills": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"valueType": "single",
"selectedValues": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"value": "text",
"icon": "text"
}
]
}
],
"defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
"outOfOfficeResponse": "text"
}Modify the details of a specific agent, such as their name, bio, status.
Authorizations
AuthorizationstringRequired
Provide the token that is returned upon login
Path parameters
workspaceIdstringRequired
Body
namestring · min: 1 · max: 50Optional
biostring · max: 240Optional
statusstring · enumOptionalPossible values:
avatarUrlstringOptional
wrapUpTimeinteger · max: 900Optional
timezonestringOptional
defaultCountryCodestringOptional
defaultCallerIdstringOptional
transcriptionLocalestring · enumOptionalPossible values:
defaultSenderIdstring · uuidOptional
The default Sender Profile to select for this agent when composing a new message.
outOfOfficeResponsestring · max: 1000Optional
Responses
200
Updated
application/json
404
Agent or workspace not found
application/json
422
Invalid agent
application/json
patch
/workspaces/{workspaceId}/agents/mePATCH /workspaces/{workspaceId}/agents/me HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1088
{
"name": "text",
"bio": "text",
"status": "active",
"avatarUrl": "text",
"dropVms": [
null
],
"wrapUpTime": 1,
"timezone": "text",
"defaultCountryCode": "text",
"defaultCallerId": "text",
"forwardNumber": {
"enabled": true,
"number": "text",
"maskCaller": true
},
"transcriptionLocale": "ar-AE",
"weeklySchedule": {
"monday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"tuesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"wednesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"thursday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"friday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"saturday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"sunday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
}
},
"holidays": [
{
"name": "text",
"day": 1,
"month": 1
}
],
"assignedSkills": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"valueType": "single",
"selectedValues": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"value": "text",
"icon": "text"
}
]
}
],
"defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
"outOfOfficeResponse": "text"
}{
"id": "text",
"status": "active",
"statusBeforeOffline": "active",
"name": "text",
"overrideName": true,
"workspaceId": "text",
"type": "user",
"userEmails": [
"text"
],
"bio": "text",
"avatarUrl": "text",
"dropVms": [
null
],
"tagCount": 1,
"wrapUpTime": 1,
"lastAssignedAt": "2025-11-28T02:12:07.730Z",
"lastSetToAwayAt": "2025-11-28T02:12:07.730Z",
"teams": [
{
"id": "text",
"name": "text",
"memberSince": "2025-11-28T02:12:07.730Z",
"activeMemberCount": 1,
"pendingMemberCount": 1
}
],
"workload": {
"id": "text",
"workload": {
"messaging": 1,
"email": 1
},
"rule": {
"id": "text",
"workspaceId": "text",
"name": "text",
"description": "text",
"default": true,
"capacity": {
"messaging": 1,
"email": 1
},
"assignedAgentIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"createdAt": "text",
"updatedAt": "text"
},
"ruleId": "text",
"updatedAt": "2025-11-28T02:12:07.730Z"
},
"createdAt": "2025-11-28T02:12:07.730Z",
"updatedAt": "2025-11-28T02:12:07.730Z",
"availability": {
"status": "active",
"activity": "available",
"activityTtl": 1,
"activityText": "text",
"lastStatusSet": "text",
"lastActivitySet": "text",
"updatedAt": "2025-11-28T02:12:07.730Z"
},
"timezone": "text",
"defaultCountryCode": "text",
"defaultCallerId": "text",
"forwardNumber": {
"enabled": true,
"number": "text",
"maskCaller": true
},
"transcriptionLocale": "ar-AE",
"roles": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "organization",
"workspaces": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
],
"user": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"avatarUrl": "text",
"defaultEmail": "text",
"phoneNumber": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"weeklySchedule": {
"monday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"tuesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"wednesday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"thursday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"friday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"saturday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
},
"sunday": {
"from": {
"hour": 1,
"minute": 1
},
"to": {
"hour": 1,
"minute": 1
}
}
},
"holidays": [
{
"name": "text",
"day": 1,
"month": 1
}
],
"assignedSkills": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"valueType": "single",
"selectedValues": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"value": "text",
"icon": "text"
}
]
}
],
"defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
"outOfOfficeResponse": "text"
}Retrieve information about availability of a specific agent.
Authorizations
AuthorizationstringRequired
Provide the token that is returned upon login
Path parameters
workspaceIdstringRequired
agentIdstringRequired
Responses
200
OK
application/json
404
Agent or workspace not found
application/json
get
/workspaces/{workspaceId}/agents/{agentId}/availabilityGET /workspaces/{workspaceId}/agents/{agentId}/availability HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "active",
"activity": "available",
"activityTtl": 1,
"activityText": "text",
"lastStatusSet": "text",
"lastActivitySet": "text",
"updatedAt": "2025-11-28T02:12:07.730Z"
}Modify the availability of a specific agent.
Authorizations
AuthorizationstringRequired
Provide the token that is returned upon login
Path parameters
workspaceIdstringRequired
agentIdstringRequired
Body
statusstring · enumRequiredPossible values:
activitystring · enumOptionalPossible values:
activityTtlinteger · min: 10 · max: 86400Optional
activityTextstring · max: 48Optional
Responses
200
Updated
application/json
404
Agent or workspace not found
application/json
422
Invalid agent
application/json
patch
/workspaces/{workspaceId}/agents/{agentId}/availabilityPATCH /workspaces/{workspaceId}/agents/{agentId}/availability HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 80
{
"status": "active",
"activity": "available",
"activityTtl": 1,
"activityText": "text"
}{
"status": "active",
"activity": "available",
"activityTtl": 1,
"activityText": "text",
"lastStatusSet": "text",
"lastActivitySet": "text",
"updatedAt": "2025-11-28T02:12:07.730Z"
}Retrieve information about workload of a specific agent.
Authorizations
AuthorizationstringRequired
Provide the token that is returned upon login
Path parameters
workspaceIdstringRequired
agentIdstringRequired
Responses
200
OK
application/json
404
Agent or workspace not found
application/json
get
/workspaces/{workspaceId}/agents/{agentId}/workloadGET /workspaces/{workspaceId}/agents/{agentId}/workload HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "text",
"workload": {
"messaging": 1,
"email": 1
},
"rule": {
"id": "text",
"workspaceId": "text",
"name": "text",
"description": "text",
"default": true,
"capacity": {
"messaging": 1,
"email": 1
},
"assignedAgentIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"createdAt": "text",
"updatedAt": "text"
},
"ruleId": "text",
"updatedAt": "2025-11-28T02:12:07.730Z"
}Last updated
Was this helpful?