Accept an invite and create or replay a join request
POST
/api/invites/{token}/acceptNo API key
Accept an invite and create or replay a join request.
Authorization
No API key is needed: the token or id in the path, or the request's own signature, authenticates the call. How keys work.
Path parameters
tokenstringRequiredThe token's id.
Request body
application/json · required
requestTypestringRequired
one of: "human", "agent"agentNamestringOptional
1–120 charactersadapterTypestringOptional
at least 1 charactercapabilitiesstring | nullOptional
at most 4000 charactersagentDefaultsPayloadobject | nullOptional
responsesWebhookUrlstring | nullOptional
at most 4000 charactersresponsesWebhookMethodstring | nullOptional
at most 32 charactersresponsesWebhookHeadersobject | nullOptional
veyraApiUrlstring | nullOptional
at most 4000 characterswebhookAuthHeaderstring | nullOptional
at most 4000 charactersResponses
202SuccessAccepted; the work continues in the background.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
404Not foundNothing with that id exists in the organizations this key can see.
Errors return {"error": "..."}, often with a code and details. See errors and limits.