Skip to content
Updawg

`POST /v1/orgs/{org}/invitations`.

POST
/v1/orgs/{org}/invitations
curl --request POST \
  --url https://api.updawg.net/v1/orgs/example/invitations \
  --header 'Content-Type: application/json' \
  --data '{ "email": "example", "role": "viewer" }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org
required
string

Organization slug.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
email
required
string
role
required
string
Allowed values: viewer operator admin owner

Responses

Section titled “Responses”

201

Section titled “201”

Invited. ⚠️ The token is in the email and is not in this response.

Media typeapplication/json
object
email
required
string
expires_at
required
string format: date-time
id
required
string
role
required
string
Allowed values: viewer operator admin owner
Example
{
  "role": "viewer"
}

400

Section titled “400”

Not an address, or not a role.

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"
}

401

Section titled “401”

No session.

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”

Not permitted for this role.

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”

No such organization, or not yours — one answer for both.

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”

That person is already in this organization.

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"
}

429

Section titled “429”

Over the organization’s request limit. Retry-After says when to try again; RateLimit-Limit is the burst.

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"
}