Sign in
assistants

Changed on
delete/v1/assistants/{id}/retire/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid
    • API key in header X-Session-Token
    • API key in header Authorization

Path parameters

idstring required

Query parameters

successor_assistant_idstring uuid

Optional assistant that inherits the retiring assistant's managed OAuth connections, e.g. the target of a teleport. Must be a live assistant owned by the caller in the same organization. The rows are moved before the retiring assistant's credentials are revoked.

Headers

Vellum-Organization-Idstring uuid

Required if using Cookie-based or X-Session-Token authentication methods.

Response

No response body

Changes