Skip to main content
POST
/
invitations
Invite user
curl --request POST \
  --url https://api.wacht.dev/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "Jane",
  "last_name": "Smith",
  "email_address": "jane.smith@example.com"
}
'
{
  "id": "1111111111",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "deployment_id": "1234567890",
  "first_name": "Jane",
  "last_name": "Smith",
  "email_address": "jane.smith@example.com",
  "token": "abc123def456",
  "expiry": "2024-01-22T10:30:00Z"
}

Authorizations

​
Authorization
string
header
required

API key authentication (Bearer token)

Body

application/json
​
first_name
string
required

Invitee's first name

Example:

"Jane"

​
last_name
string
required

Invitee's last name

Example:

"Smith"

​
email_address
string<email>
required

Invitee's email address

Example:

"jane.smith@example.com"

Response

Invitation created successfully

​
id
string
required

Invitation ID (integer serialized as string)

Example:

"1111111111"

​
created_at
string<date-time>
required
Example:

"2024-01-15T10:30:00Z"

​
updated_at
string<date-time>
required
Example:

"2024-01-15T10:30:00Z"

​
deployment_id
string
required

Deployment ID (integer serialized as string)

Example:

"1234567890"

​
first_name
string
required

Invitee's first name

Example:

"Jane"

​
last_name
string
required

Invitee's last name

Example:

"Smith"

​
email_address
string<email>
required

Invitee's email address

Example:

"jane.smith@example.com"

​
token
string
required

Unique invitation token

Example:

"abc123def456"

​
expiry
string<date-time>
required

Invitation expiration timestamp

Example:

"2024-01-22T10:30:00Z"