POST/api/v1/invite-to-workspace

Invite a member to a workspace

Invites someone to a workspace by email with a chosen role, and sends them an invitation email.

AccessRequires a permission in the workspaceMANAGE_USERS

workspace_context is the workspace being invited into, org_id is the organisation that workspace belongs to, and role_id is the role the person holds in that workspace once they accept. At least one role must exist in the workspace before you can invite anyone, since there is nothing to assign otherwise: see Roles and permissions. The call sends an invitation email and returns the invite_id it created.

Use this call for someone who is not in the workspace yet. To place a user who already has an account into another workspace directly, use POST /api/v1/add-workspace-to-user, which is gated on MANAGE_WORKSPACE rather than MANAGE_USERS.

A role alone does not make someone a signer

Accepting an invitation gives a member the permissions their role carries, but not the ability to approve movements. Before they can take part in signing they must set up a signing profile and register a key through POST /api/v1/register-key. The operator walkthrough is Inviting and managing users.

Body parameters

invited_emailstringrequired

The email address the invitation is sent to.

workspace_contextnumberrequired

The workspace being invited into. You must hold MANAGE_USERS in it.

org_idnumberrequired

The organisation the workspace belongs to.

role_idnumberrequired

The role the person holds in the workspace once they accept. At least one role must exist in the workspace before you can invite anyone.

bash

curl -X POST "$SQRL_API/api/v1/invite-to-workspace" \
  -H "authorization: Bearer $SQRL_TOKEN" \
  -H "content-type: application/json" \
  -d '{
        "invited_email": "operator@example.com",
        "workspace_context": 342,
        "org_id": 118,
        "role_id": 77
      }'

const res = await fetch(`${process.env.SQRL_API}/api/v1/invite-to-workspace`, {
  method: "POST",
  headers: {
    authorization: `Bearer ${process.env.SQRL_TOKEN}`,
    "content-type": "application/json",
  },
  body: JSON.stringify({
    invited_email: "operator@example.com",
    workspace_context: 342,
    org_id: 118,
    role_id: 77,
  }),
});
const { success, invite_id } = await res.json();

rust

let res = client
    .post(format!("{}/api/v1/invite-to-workspace", api_base))
    .bearer_auth(&token)
    .json(&serde_json::json!({
        "invited_email": "operator@example.com",
        "workspace_context": 342,
        "org_id": 118,
        "role_id": 77,
    }))
    .send()
    .await?;

Response200 OK

{
"success": true,
"invite_id": 1204
}

#What happens next

The invited person receives an email. Until they respond, the invitation shows on GET /api/v1/get-pending-workspace-invites for the workspace and on GET /api/v1/get-invites-pending for them. They accept or decline with GET /api/v1/accept-invite, after which they appear in GET /api/v1/get-users-from-workspace.

Was this page helpful?