Agent Management
Update Agent
Update an existing agent's role and availability
PUT
/
agent
/
{id}
Authorization
Path
Body
curl --request PUT \
--url https://chat.zoko.io/v2/agent/{id} \
--header 'Content-Type: application/json' \
--header 'apikey: <apikey>' \
--data '{
"active": true,
"available": true,
"email": "<string>",
"firstName": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lastName": "<string>",
"role": "owner"
}'
{
"active": true,
"available": true,
"email": "<string>",
"firstName": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lastName": "<string>",
"role": "owner"
}
Authorizations
apikey
string
headerrequiredAuthentication is done via apikey
provided for your account
Include the following in your request header
apikey: "your_apikey_here"
Path Parameters
id
string
requiredID or email of the agent
Body
application/json
active
boolean
is the agent active?
available
boolean
email
string
email of agent
firstName
string
first name of agent
id
string
agent id
lastName
string
last name of agent
role
enum<string>
role of the agent
Available options:
owner
, admin
, salesman
Response
200 - application/json
active
boolean
is the agent active?
available
boolean
email
string
email of agent
firstName
string
first name of agent
id
string
agent id
lastName
string
last name of agent
role
enum<string>
role of the agent
Available options:
owner
, admin
, salesman
curl --request PUT \
--url https://chat.zoko.io/v2/agent/{id} \
--header 'Content-Type: application/json' \
--header 'apikey: <apikey>' \
--data '{
"active": true,
"available": true,
"email": "<string>",
"firstName": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lastName": "<string>",
"role": "owner"
}'
{
"active": true,
"available": true,
"email": "<string>",
"firstName": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lastName": "<string>",
"role": "owner"
}