Agent Management

List Agents

get

Authorizations

Path parameters

workspaceIdstringRequired

Query parameters

limitinteger · min: 1 · max: 100Optional

Limits the number of results to return

Default: 10

pageTokenstring · max: 8000Optional

Pagination token that keeps of track of the current position in the list

reversebooleanOptional

Order in which to retrieve the results

Default: false

sortBystring · enumOptional

Sort by field specified

Available options:

namestringOptional

Filter by agent name

emailstringOptional

Filter by agent email

agentStatusesstring · enum[]Optional

Filter by agent status

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

application/json

all ofOptional

application/json

get

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/agents HTTP/1.1
Host: 
Authorization: Bearer jwt
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-04-19T14:41:49.339Z",
      "lastSetToAwayAt": "2025-04-19T14:41:49.339Z",
      "teams": [
        {
          "id": "text",
          "name": "text",
          "memberSince": "2025-04-19T14:41:49.339Z",
          "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-04-19T14:41:49.339Z"
      },
      "createdAt": "2025-04-19T14:41:49.339Z",
      "updatedAt": "2025-04-19T14:41:49.339Z",
      "availability": {
        "status": "active",
        "activity": "available",
        "activityTtl": 1,
        "activityText": "text",
        "lastStatusSet": "text",
        "lastActivitySet": "text",
        "updatedAt": "2025-04-19T14:41:49.339Z"
      },
      "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 Agent

post

Create a new agent with specified details like name, role, and basic bio.

Authorizations

Path parameters

workspaceIdstringRequired

Body

one ofOptional

Responses

application/json

objectOptional

application/json

application/json

application/json

post

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/agents HTTP/1.1
Host: 
Authorization: Bearer jwt
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-04-19T14:41:49.339Z",
  "lastSetToAwayAt": "2025-04-19T14:41:49.339Z",
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2025-04-19T14:41:49.339Z",
      "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-04-19T14:41:49.339Z"
  },
  "createdAt": "2025-04-19T14:41:49.339Z",
  "updatedAt": "2025-04-19T14:41:49.339Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 1,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2025-04-19T14:41:49.339Z"
  },
  "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"
}

List All Agents

get

Lists all agents for a workspace returning only minimal fields for each agent.

Authorizations

Path parameters

workspaceIdstringRequired

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/all-agents HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

200

OK

{
  "results": [
    {
      "id": "text",
      "status": "active",
      "activity": "available",
      "name": "text",
      "avatarUrl": "text",
      "createdAt": "2025-04-19T14:41:49.339Z"
    }
  ]
}

Get Agent

get

Retrieve information about a specific agent, including their name, bio, status.

Authorizations

Path parameters

workspaceIdstringRequired

agentIdstringRequired

Responses

application/json

objectOptional

application/json

get

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/agents/{agentId} HTTP/1.1
Host: 
Authorization: Bearer jwt
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-04-19T14:41:49.339Z",
  "lastSetToAwayAt": "2025-04-19T14:41:49.339Z",
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2025-04-19T14:41:49.339Z",
      "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-04-19T14:41:49.339Z"
  },
  "createdAt": "2025-04-19T14:41:49.339Z",
  "updatedAt": "2025-04-19T14:41:49.339Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 1,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2025-04-19T14:41:49.339Z"
  },
  "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"
}

Get url to upload profile avatar to

get

Retrieve the url and form data to post profile avatar directly.

Authorizations

Path parameters

workspaceIdstringRequired

agentIdstringRequired

Responses

application/json

objectOptional

Url and Form data needed to upload an image

get

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/agents/{agentId}/presigned-upload HTTP/1.1
Host: 
Authorization: Bearer jwt
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 url to upload audio files

post

Retrieve the url and form data to post audio files directly.

Authorizations

Path parameters

workspaceIdstringRequired

agentIdstringRequired

Responses

application/json

objectOptional

Url and Form data needed to upload an image

post

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/agents/{agentId}/presigned-upload/audio HTTP/1.1
Host: 
Authorization: Bearer jwt
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 agent media download

get

Get media download from an agent

Authorizations

Path parameters

workspaceIdstringRequired

agentIdstringRequired

fileIdstringRequired

Query parameters

redirectbooleanOptional

Responses

application/json

application/json

get

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/agents/{agentId}/media/{fileId}/download HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

No content

Update Agent

patch

Modify the details of a specific agent, such as their name, bio, status.

Authorizations

Path parameters

workspaceIdstringRequired

agentIdstringRequired

Body

namestring · min: 1 · max: 50Optional

biostring · max: 240Optional

statusstring · enumOptionalAvailable options:

avatarUrlstringOptional

dropVmsone of[] · max: 3Optional

wrapUpTimeinteger · max: 900Optional

timezonestringOptional

defaultCountryCodestringOptional

defaultCallerIdstringOptional

forwardNumberobjectOptional

transcriptionLocalestring · enumOptionalAvailable options:

weeklyScheduleobjectOptional

holidaysobject[]Optional

assignedSkillsobject[]Optional

AgentAssignedSkill is a denormalized AgentSkill, and a part of Agent entity.

defaultSenderIdstring · uuidOptional

The default Sender Profile to select for this agent when composing a new message.

outOfOfficeResponsestring · max: 1000Optional

Responses

application/json

objectOptional

application/json

application/json

patch

HTTPcURLJavaScriptPython

PATCH /workspaces/{workspaceId}/agents/{agentId} HTTP/1.1
Host: 
Authorization: Bearer jwt
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-04-19T14:41:49.339Z",
  "lastSetToAwayAt": "2025-04-19T14:41:49.339Z",
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2025-04-19T14:41:49.339Z",
      "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-04-19T14:41:49.339Z"
  },
  "createdAt": "2025-04-19T14:41:49.339Z",
  "updatedAt": "2025-04-19T14:41:49.339Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 1,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2025-04-19T14:41:49.339Z"
  },
  "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"
}

Delete Agent

delete

Remove a specific agent from the system, permanently deleting their profile and associated data.

Authorizations

Path parameters

workspaceIdstringRequired

agentIdstringRequired

Responses

application/json

delete

HTTPcURLJavaScriptPython

DELETE /workspaces/{workspaceId}/agents/{agentId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

No content

Get Agent

get

Retrieve information about a specific agent, including their name, bio, status.

Authorizations

Path parameters

workspaceIdstringRequired

Responses

application/json

objectOptional

application/json

get

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/agents/me HTTP/1.1
Host: 
Authorization: Bearer jwt
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-04-19T14:41:49.339Z",
  "lastSetToAwayAt": "2025-04-19T14:41:49.339Z",
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2025-04-19T14:41:49.339Z",
      "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-04-19T14:41:49.339Z"
  },
  "createdAt": "2025-04-19T14:41:49.339Z",
  "updatedAt": "2025-04-19T14:41:49.339Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 1,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2025-04-19T14:41:49.339Z"
  },
  "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"
}

Update Agent

patch

Modify the details of a specific agent, such as their name, bio, status.

Authorizations

Path parameters

workspaceIdstringRequired

Body

namestring · min: 1 · max: 50Optional

biostring · max: 240Optional

statusstring · enumOptionalAvailable options:

avatarUrlstringOptional

dropVmsone of[] · max: 3Optional

wrapUpTimeinteger · max: 900Optional

timezonestringOptional

defaultCountryCodestringOptional

defaultCallerIdstringOptional

forwardNumberobjectOptional

transcriptionLocalestring · enumOptionalAvailable options:

weeklyScheduleobjectOptional

holidaysobject[]Optional

assignedSkillsobject[]Optional

AgentAssignedSkill is a denormalized AgentSkill, and a part of Agent entity.

defaultSenderIdstring · uuidOptional

The default Sender Profile to select for this agent when composing a new message.

outOfOfficeResponsestring · max: 1000Optional

Responses

application/json

objectOptional

application/json

application/json

patch

HTTPcURLJavaScriptPython

PATCH /workspaces/{workspaceId}/agents/me HTTP/1.1
Host: 
Authorization: Bearer jwt
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-04-19T14:41:49.339Z",
  "lastSetToAwayAt": "2025-04-19T14:41:49.339Z",
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2025-04-19T14:41:49.339Z",
      "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-04-19T14:41:49.339Z"
  },
  "createdAt": "2025-04-19T14:41:49.339Z",
  "updatedAt": "2025-04-19T14:41:49.339Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 1,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2025-04-19T14:41:49.339Z"
  },
  "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"
}

Get Agent Availability

get

Retrieve information about availability of a specific agent.

Authorizations

Path parameters

workspaceIdstringRequired

agentIdstringRequired

Responses

application/json

objectOptional

application/json

get

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/agents/{agentId}/availability HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

{
  "status": "active",
  "activity": "available",
  "activityTtl": 1,
  "activityText": "text",
  "lastStatusSet": "text",
  "lastActivitySet": "text",
  "updatedAt": "2025-04-19T14:41:49.339Z"
}

Update Agent Availability

patch

Modify the availability of a specific agent.

Authorizations

Path parameters

workspaceIdstringRequired

agentIdstringRequired

Body

statusstring · enumRequiredAvailable options:

activitystring · enumOptionalAvailable options:

activityTtlinteger · min: 10 · max: 86400Optional

activityTextstring · max: 48Optional

Responses

application/json

objectOptional

application/json

application/json

patch

HTTPcURLJavaScriptPython

PATCH /workspaces/{workspaceId}/agents/{agentId}/availability HTTP/1.1
Host: 
Authorization: Bearer jwt
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-04-19T14:41:49.339Z"
}

Get Agent Workload

get

Retrieve information about workload of a specific agent.

Authorizations

Path parameters

workspaceIdstringRequired

agentIdstringRequired

Responses

application/json

objectOptional

application/json

get

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/agents/{agentId}/workload HTTP/1.1
Host: 
Authorization: Bearer jwt
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-04-19T14:41:49.339Z"
}