Accept an invite and create or replay a join request

POST/api/invites/{token}/accept
No API key
Veyra Docs TeamUpdated Version 4 · History

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

requestTypestringRequiredone of: "human", "agent"
agentNamestringOptional1–120 characters
adapterTypestringOptionalat least 1 character
capabilitiesstring | nullOptionalat most 4000 characters
agentDefaultsPayloadobject | nullOptional
responsesWebhookUrlstring | nullOptionalat most 4000 characters
responsesWebhookMethodstring | nullOptionalat most 32 characters
responsesWebhookHeadersobject | nullOptional
veyraApiUrlstring | nullOptionalat most 4000 characters
webhookAuthHeaderstring | nullOptionalat most 4000 characters

Responses

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.

Members, invites and keys