POST/api/v1/answer-invite

Accept or decline an invitation

Responds to a workspace invitation addressed to the signed-in user, accepting it with the invited role or declining it.

AccessRequires a signed-in caller

Updated 08 Nov 20261 min read

The invitation is identified by the workspace it is for, not by the InviteUID that GET /api/v1/get-invites-pending returns, so pass the Workspace.uid from that list as workspace_uid. Send accept: true to accept and take up the invited role, or accept: false to decline. Either way the invitation stops being outstanding.

Body parameters

workspace_uidnumberRequired

The workspace the invitation is for, as returned in Workspace.uid by get-invites-pending.

acceptbooleanRequired

Whether to take up the invitation. true accepts it, false declines it.

bash

curl -X POST "$SQRL_API/api/v1/answer-invite" \
  -H "authorization: Bearer $SQRL_TOKEN" \
  -H "content-type: application/json" \
  -d '{ "workspace_uid": 342, "accept": true }'

const res = await fetch(`${process.env.SQRL_API}/api/v1/answer-invite`, {
  method: "POST",
  headers: {
    authorization: `Bearer ${process.env.SQRL_TOKEN}`,
    "content-type": "application/json",
  },
  body: JSON.stringify({ workspace_uid: 342, accept: true }),
});
const { Success } = await res.json();

rust

let res = client
    .post(format!("{}/api/v1/answer-invite", api_base))
    .bearer_auth(&token)
    .json(&serde_json::json!({ "workspace_uid": 342, "accept": true }))
    .send()
    .await?;

Response200 OK

{
  "Success": true
}

Was this page helpful?