LogoLogo
No-code docsResources
  • 🖥️Welcome to the Bird API Docs
  • API Access
    • Access Policies
    • Access Roles
    • API Authorization
    • Common API usage
  • Conversations API
    • API reference
      • Channel configuration
        • Get conversations configuration
        • Update conversations configuration
      • Conversations messaging
        • Create conversation message
        • List conversation messages
        • Get conversation message
        • Update conversation message
        • Delete conversation message
        • Create pre-signed upload
      • Conversations management
        • Create conversation
        • List conversations
        • Get conversation
        • Update conversation
        • Delete conversation
      • Conversation Participants
        • Add participant to conversation
        • List participants
        • Get participant by ID
        • Get participant by identifier key and value
        • Update participant by ID
        • Update participant by identifier key and value
        • Delete participant
        • List participant conversations by ID
        • List participant conversations by identifier key and value
      • Workspace settings
        • Get antispam setting
        • Update antispam setting
        • Create allow/block rule
        • Get allow/block rule
        • List allow/block rules
        • Update allow/block rule
        • Delete allow/block rule
        • Add allow/block rules in bulk
        • Get allow/block bulk upload status
      • Events
  • Collaborations API
    • API reference
      • Agent Management
      • Team Management
      • Feeds
      • Feed item activity
      • Tags
      • Automation Rules
      • Business Hours
      • Capacity Rules
      • Routing Queues
      • Skills
      • SLA Policies
      • Macros
      • Sender Profiles
      • Ticket fields
  • Channels API
    • Supported channels
      • Programmable WhatsApp
        • Sending WhatsApp messages
        • Customer service window
        • Receiving messages
        • Message interactions
        • WhatsApp ISV integration
          • Setting up your customer workspaces
            • API Access
            • Associating your Facebook solution ID and business ID with your Bird CRM Organization
            • Creating a workspace for your customer
            • Buying a number through Bird
            • Subscribing to channel created webhooks
          • WhatsApp channel onboarding
            • Setting up the WhatsApp Embedded flow
            • Install WhatsApp phone number in Bird CRM
            • Subscribe to channel webhooks
      • Programmable SMS
        • Installing an SMS channel
          • US 10DLC API Installation
          • Toll-Free Numbers Verification API
        • Sending SMS messages
        • Receiving messages
        • Twilio Exit API
          • Using Twilio PHP SDK
          • Using Twilio Go SDK
          • Using Twilio Ruby SDK
        • Sinch Exit API
      • Programmable RCS
        • Sending messages
        • Receiving messages
        • Message interactions
      • Programmable Email
        • Sending Emails
        • Receiving messages
        • Message status
        • Message interactions
      • Programmable Line
        • Sending messages
        • Receiving messages
        • Message interactions
      • Programmable Telegram
        • Sending messages
        • Receiving messages
        • Message interactions
    • Message types
      • Text
      • Images
      • Files
      • List
      • Carousel
      • Template
    • Message status and interactions
      • Message Failure Codes
      • Message Failure Sources
        • SMS Platform Extended Error Codes
    • Send batch messages
    • API reference
      • Channel Groups
      • Messaging
      • Channels management
      • Channel connectors
      • Navigators
      • Compliance Keywords Messages
      • Conversions Sharing
      • Events
    • Rate Limit
  • Voice API
    • Installing a Voice channel
    • Voice Calls API
      • Initiate an outbound call
      • List calls from a channel
      • Get a call
      • Update a call
      • Answer a call
      • Ring a call
      • Hangup a call
      • Play a message in a call
      • Say Text-To-Speech (TTS)
      • Gather DTMF from a call
      • Forward a call
      • Record a Call
      • Record a call session
      • Update a call recording
      • List call recordings of a call
      • Get a call recording
      • Get a call insights
      • Get calls log
    • Recordings API
      • List Recordings
      • Get a Recording
      • Delete a Recording
      • List recording storage metrics
    • Transcriptions API
      • Initiate a Transcription
      • List Transcriptions
      • Get a Transcription
      • Delete a Transcription
    • Voice webhooks
    • Flash Calling API
  • Verify API
    • Verify API: Quick Start
  • Contacts API
    • Tracking Contact Events
      • API Reference
        • Get configuration
        • Track events
    • API reference
      • Manage workspace contacts
        • Create a contact
        • Get a contact
        • List contacts
        • Search contact by identifier
        • Update a contact
        • Create or update a contact by identifier
        • Delete a contact
      • Manage contact identifiers
        • Create contact identifier
        • List contact identifiers
        • Delete contact identifier
      • Manage contact attribute definition
        • Create attribute definition
        • Get attribute definition
        • List attribute definitions
      • Manage contact lists
        • Create a list
        • Get a list
        • List lists
        • Update a list
        • Delete a list
        • Add contacts to a list
        • Get contact list memberships
        • List contacts in a list
        • Remove contacts from a list
      • Lookup
        • Network/Country information for a phone number
  • Numbers API
    • API reference
      • Search Available Numbers
      • Buy a Number
      • List your Numbers
      • Get Long Code Number Details
      • Manage Endpoint Subscriptions
        • Cancel Number Subscription
      • Manage Endpoint Compliance Requirements
        • List Workspace compliace Requirements
        • Get Workspace Compliace Requirements
        • Update Workspace Compliace Requirements
      • 10DLC Compliance
        • Brands - Organization
          • Create a brand
          • List all brands
          • Get a brand
          • Update a brand
          • Delete a brand
          • Create a brand vetting
        • Brands - workspace
          • Create a brand
          • List all brands
          • Get a brand
          • Update a brand
          • Delete a brand
          • Create a brand vetting
          • List brand vettings
        • Campaigns
          • Optional: acting as Reseller
          • Create a campaign
          • List all campaigns
          • Get a campaign
          • Update a campaign
          • Delete a campaign
        • TCR Enums
        • Events
      • Toll-Free Numbers Verification API
      • Long Code Numbers
      • Short Code Numbers
      • Alphanumeric Senders
      • Events
  • Know-Your-Customer (KYC) API
    • List KYC forms
    • Get KYC form
    • Create KYC form entry
    • Update KYC form entry
    • List KYC form entries
    • Get a KYC form entry details
  • Reporting API
    • API reference
      • Channel Metrics
      • Flow Run Metrics
      • Wallet Metrics
      • Campaign Metrics
      • Message Metrics
  • Accounts API
    • API reference
      • Current user
        • Change password
        • Presigned upload
        • Memberships
        • Sessions
        • Configurations
          • Groups
            • Keys
      • IAM policies
      • Organizations
        • Upload media
        • Profile
        • Workspaces
        • Users
        • Access keys
        • Organization roles
        • Organization policies
        • Teams
          • Members
        • Approvals
          • Runs
            • Reviews
        • Configurations
          • Groups
            • Keys
      • Region groups
  • Touchpoints API
    • Supported Projects
      • Whatsapp Approved Message Templates
        • Creating WhatsApp Message templates
          • Text template blocks
          • Blocks Documentation
    • API reference
      • Projects
      • Message Templates
  • Notifications API
    • API Reference
      • Webhook subscriptions
        • Create a webhook subscription
        • List available webhook events
        • Get a webhook subscription
        • List webhook subscriptions
        • Update a webhook subscription
        • Delete a webhook subscription
        • Verifying a webhook subscription
        • Webhook subscription logs
  • Knowledge Base (KB) API
    • API reference
      • Documents
      • Folders
        • Import
      • Search
      • Presigned upload
  • Email API
    • Transmissions
  • Connectivity platform migration guide
    • Channels API and Conversations API
    • Migrating conversations API actions
    • Migrating WhatsApp channels
  • Client SDKs
    • Applications
    • Contact Profiles
      • Signed Identity
    • Push notifications
      • Quick Start
      • Subscribe contacts to push notification campaigns
      • Notification Display Priority
    • Event Tracking
      • Quick Start
      • Track Events
        • App
        • Audiences
        • Conference
        • Ecommerce
        • Hospitality
        • Lists
        • Messaging
        • Payments
        • Subscription
        • Suppressions
        • Survey
        • Web
    • App Inbox
      • Quick Start
      • Usage
      • Subscribe contacts to app inbox campaigns
    • SDK Integration
      • Android SDK
        • Notification Interactions
      • Swift SDK
        • Notification Interactions
      • Web SDK
        • Quick Start
        • Usage
        • API Reference
          • IdentityManager
          • BirdSdkApi
          • BirdTracker
            • Ecommerce
            • Conference
            • Messaging
            • Suppressions
            • Subscription
            • Survey
            • Web
            • Audiences
        • Web Push Notifications
          • Notification Interactions
  • Quickstarts
    • Conversations
    • Send an SMS message
    • Send an Email message
    • Send a WhatsApp message
Powered by GitBook
On this page

Was this helpful?

  1. Collaborations API
  2. API reference

Agent Management

Last updated 7 months ago

Was this helpful?

List All Agents

get

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

Authorizations
Path parameters
workspaceIdstringRequired
Responses
200
OK
application/json
get
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-05-09T04:26:26.850Z"
    }
  ]
}

Get Agent

get

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

Authorizations
Path parameters
workspaceIdstringRequired
agentIdstringRequired
Responses
200
OK
application/json
404
Agent or workspace not found
application/json
get
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-05-09T04:26:26.850Z",
  "lastSetToAwayAt": "2025-05-09T04:26:26.850Z",
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2025-05-09T04:26:26.850Z",
      "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-05-09T04:26:26.850Z"
  },
  "createdAt": "2025-05-09T04:26:26.850Z",
  "updatedAt": "2025-05-09T04:26:26.850Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 1,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2025-05-09T04:26:26.850Z"
  },
  "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
200
OK
application/json
get
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
200
OK
application/json
post
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
200
Return file location
302
Redirect to file location
400
Bad request
application/json
404
The resource is not found
application/json
get
GET /workspaces/{workspaceId}/agents/{agentId}/media/{fileId}/download HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

No content

Delete Agent

delete

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

Authorizations
Path parameters
workspaceIdstringRequired
agentIdstringRequired
Responses
204
Deleted
404
Agent or workspace not found
application/json
delete
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
200
OK
application/json
404
Agent or workspace not found
application/json
get
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-05-09T04:26:26.850Z",
  "lastSetToAwayAt": "2025-05-09T04:26:26.850Z",
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2025-05-09T04:26:26.850Z",
      "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-05-09T04:26:26.850Z"
  },
  "createdAt": "2025-05-09T04:26:26.850Z",
  "updatedAt": "2025-05-09T04:26:26.850Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 1,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2025-05-09T04:26:26.850Z"
  },
  "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
200
OK
application/json
404
Agent or workspace not found
application/json
get
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-05-09T04:26:26.850Z"
}

Get Agent Workload

get

Retrieve information about workload of a specific agent.

Authorizations
Path parameters
workspaceIdstringRequired
agentIdstringRequired
Responses
200
OK
application/json
404
Agent or workspace not found
application/json
get
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-05-09T04:26:26.850Z"
}
  • GETList Agents
  • POSTCreate Agent
  • GETList All Agents
  • GETGet Agent
  • GETGet url to upload profile avatar to
  • POSTGet url to upload audio files
  • GETGet agent media download
  • PATCHUpdate Agent
  • DELETEDelete Agent
  • GETGet Agent
  • PATCHUpdate Agent
  • GETGet Agent Availability
  • PATCHUpdate Agent Availability
  • GETGet Agent Workload

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

Possible values:
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
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-05-09T04:26:26.850Z",
      "lastSetToAwayAt": "2025-05-09T04:26:26.850Z",
      "teams": [
        {
          "id": "text",
          "name": "text",
          "memberSince": "2025-05-09T04:26:26.850Z",
          "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-05-09T04:26:26.850Z"
      },
      "createdAt": "2025-05-09T04:26:26.850Z",
      "updatedAt": "2025-05-09T04:26:26.850Z",
      "availability": {
        "status": "active",
        "activity": "available",
        "activityTtl": 1,
        "activityText": "text",
        "lastStatusSet": "text",
        "lastActivitySet": "text",
        "updatedAt": "2025-05-09T04:26:26.850Z"
      },
      "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
or
Responses
201
Created
application/json
404
Workspace not found
application/json
409
Agent already exists
application/json
422
Invalid agent
application/json
post
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-05-09T04:26:26.850Z",
  "lastSetToAwayAt": "2025-05-09T04:26:26.850Z",
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2025-05-09T04:26:26.850Z",
      "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-05-09T04:26:26.850Z"
  },
  "createdAt": "2025-05-09T04:26:26.850Z",
  "updatedAt": "2025-05-09T04:26:26.850Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 1,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2025-05-09T04:26:26.850Z"
  },
  "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
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
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-05-09T04:26:26.850Z",
  "lastSetToAwayAt": "2025-05-09T04:26:26.850Z",
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2025-05-09T04:26:26.850Z",
      "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-05-09T04:26:26.850Z"
  },
  "createdAt": "2025-05-09T04:26:26.850Z",
  "updatedAt": "2025-05-09T04:26:26.850Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 1,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2025-05-09T04:26:26.850Z"
  },
  "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 · 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
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-05-09T04:26:26.850Z",
  "lastSetToAwayAt": "2025-05-09T04:26:26.850Z",
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2025-05-09T04:26:26.850Z",
      "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-05-09T04:26:26.850Z"
  },
  "createdAt": "2025-05-09T04:26:26.850Z",
  "updatedAt": "2025-05-09T04:26:26.850Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 1,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2025-05-09T04:26:26.850Z"
  },
  "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 Availability

patch

Modify the availability of a specific agent.

Authorizations
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
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-05-09T04:26:26.850Z"
}