Skip to content
Updawg

`POST /v1/invitations/join`.

POST
/v1/invitations/join
curl --request POST \
  --url https://api.updawg.net/v1/invitations/join \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "token": "example" }'

For somebody with no account: makes one for the address the invitation was sent to, takes the invitation up, and signs them in.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required

The person’s name, as their colleagues will see it.

string
token
required
string
Examplegenerated
{
  "name": "example",
  "token": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

The account exists, has joined, and this is a session for it. Sets the session cookie.

Media typeapplication/json
object
csrf_token
required

The token every mutation echoes in X-Updawg-Csrf.

string
Examplegenerated
{
  "csrf_token": "example"
}

400

Section titled “400”

No name, or one too long.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

403

Section titled “403”

Joined, but the address’s organization requires single sign-on, so the session starts there instead: sso-required (DAWG-155).

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

404

Section titled “404”

Unknown, expired, already taken up or withdrawn — one answer for all four.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

409

Section titled “409”

The invited address already has an account: sign in, then accept.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}