La referencia de la API se publica en inglés.

Create a one-use Dot pairing code as an organization operator

POST/api/companies/{companyId}/agents/{agentId}/dot-binding
Personal API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

Create a one-use Dot pairing code as an organization operator.

Autorización

Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. Cómo funcionan las claves.

Parámetros de ruta

companyIdstringObligatorioThe organization's id.
agentIdstringObligatorioThe agent's id.

Cuerpo de la solicitud

application/json · obligatorio

dotUrlstringOpcionalat most 2048 characters
replaceBindingIdstring (uuid)Opcional

Respuestas

201SuccessCreated; the body holds the new resource.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Agents