Add a New Agent - Yampi

Add a New Agent

curl --request POST \
  --url https://app.yampi.ai/api/v1/accounts/{account_id}/agents \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "name": "John Doe",
  "email": "[email protected]",
  "role": "agent"
}
'

const options = {
  method: 'POST',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'John Doe', email: '[email protected]', role: 'agent'})
};

fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/agents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://app.yampi.ai/api/v1/accounts/{account_id}/agents"

payload = {
    "name": "John Doe",
    "email": "[email protected]",
    "role": "agent"
}
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": 123,
  "account_id": 123,
  "availability_status": "online",
  "auto_offline": true,
  "confirmed": true,
  "email": "<string>",
  "available_name": "<string>",
  "name": "<string>",
  "role": "agent",
  "thumbnail": "<string>",
  "custom_role_id": 123,
  "system_role": "commercial"
}

{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

POST

/

api

/

v1

/

accounts

/

{account_id}

/

agents

Add a New Agent

curl --request POST \
  --url https://app.yampi.ai/api/v1/accounts/{account_id}/agents \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "name": "John Doe",
  "email": "[email protected]",
  "role": "agent"
}
'

const options = {
  method: 'POST',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'John Doe', email: '[email protected]', role: 'agent'})
};

fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/agents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://app.yampi.ai/api/v1/accounts/{account_id}/agents"

payload = {
    "name": "John Doe",
    "email": "[email protected]",
    "role": "agent"
}
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": 123,
  "account_id": 123,
  "availability_status": "online",
  "auto_offline": true,
  "confirmed": true,
  "email": "<string>",
  "available_name": "<string>",
  "name": "<string>",
  "role": "agent",
  "thumbnail": "<string>",
  "custom_role_id": 123,
  "system_role": "commercial"
}

{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

Authorizations

api_access_token

string

header

required

Token de usuario. Envía el valor en el header api_access_token. Lo obtienes en el perfil (GET /api/v1/profile) o al regenerarlo.

Path Parameters

account_id

integer

required

The numeric ID of the account

Body

application/json

name

string

required

Full Name of the agent

Example:

"John Doe"

email

string

required

Email of the Agent

Example:

"[email protected]"

role

enum<string>

required

Whether its administrator or agent

Available options:

agent,

administrator

Example:

"agent"

availability

enum<string>

The configured availability of the agent.

Available options:

online,

busy,

offline

Example:

"online"

auto_offline

boolean

Whether the agent is automatically marked offline when they are away.

Example:

true

system_role

enum<string> | null

Rol de sistema del miembro en la cuenta. Convive con role (agent | administrator) y custom_role_id. Null ok.

Available options:

commercial,

marketing,

service,

legal,

treasury,

accounting,

commercial_admin,

service_admin,

administrative_admin

custom_role_id

integer | null

ID del rol personalizado. Envíalo junto con system_role al crear o actualizar el agente.

Response

Success

id

integer

account_id

integer

availability_status

enum<string>

read-only

The effective availability status of the agent, derived from the configured availability, auto-offline setting, and current presence. To update an agent's configured availability, use the availability field in create or update requests.

Available options:

online,

busy,

offline

auto_offline

boolean

Whether the agent is automatically marked offline when they are away.

confirmed

boolean

Whether the agent has confirmed their email address.

email

string

The email of the agent

available_name

string

The available name of the agent

name

string

The name of the agent

role

enum<string>

The role of the agent

Available options:

agent,

administrator

thumbnail

string

The thumbnail of the agent

custom_role_id

integer

The custom role id of the agent

system_role

enum<string> | null

Rol de sistema del miembro en la cuenta. Convive con role (agent | administrator) y custom_role_id. Null ok.

Available options:

commercial,

marketing,

service,

legal,

treasury,

accounting,

commercial_admin,

service_admin,

administrative_admin