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

Update the setup phase for an addressed connection request

POST/api/connection-intents/{interactionId}/phase
Personal API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

Update the setup phase for an addressed connection request.

Person-only: a connection request card is addressed to one person, its addresseeUserId. Only that person, signed in to their own browser, can open its setup, connect their account or decline it. The server refuses every other member, member and agent, so nobody can finish it for them. When someone else offers to finish it, tell them the addressee must connect their own account from the card on its task, linked as . Do not create another request for the addressee and do not search for another route.

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

interactionIdstringObligatorioThe interaction's id.

Cuerpo de la solicitud

application/json · obligatorio

phasestringObligatorioone of: "requested", "authorizing", "needs_retry"
setupAccessobjectOpcional
setupAccess.connectionIdstring (uuid)Obligatorio
setupAccess.accessstring | objectObligatorio

Respuestas

200SuccessThe request worked; the body holds the result.
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.
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).

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

Connection requests