Accept an invitation waiting for you

POST

/auth/invitations/{id}/accept

curl --request POST \
  --url https://api.sloose.com/auth/invitations/01a0f0c4-%E2%80%A6/accept \
  --header 'Authorization: Bearer <token>'

• Production
• Staging

Joins the org at the invited role, exactly as the invitation’s link does, for an invitation to the address this session signed in with. The session moves to that org.

An id that names no invitation to that address is not found, whether or not it names somebody else’s: the answer never says an id is in use.

Session only, and not a staff member’s view of an org, which does not act as the person outside it.

Authorizations

• sessionAuth

Parameters

Path Parameters

id

required

The invitation, from GET /auth/invitations.

string

Example

01a0f0c4-…

The invitation, from GET /auth/invitations.

Responses

200

Joined.

Media typeapplication/json

object

orgId

required

string

orgName

required

string

role

required

string

Allowed values: owner admin builder operator

Example

{
  "role": "owner"
}

401

No bearer, or one that is expired, revoked or no longer resolves to a member.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

403

An API token was used (code: SESSION_REQUIRED), or the session is a staff member’s view of an org (code: STAFF_VIEW).

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

404

No such invitation, or it is not visible to this session.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

409

The invitation is withdrawn, used or expired; or its org has been closed (ORG_CLOSED); or the membership kept changing while it was being accepted (MEMBERSHIP_CHANGING); or the person is the org’s only owner and the invitation is for a lower role (LAST_OWNER). In the last three the invitation is still pending.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}