Skip to main content
POST
/
users
/
{id}
/
invite
Resend a user invitation
curl --request POST \
  --url https://api.smokeball.com/users/{id}/invite \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "email": "<string>"
}'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Authorizations

x-api-key
string
header
required
Authorization
string
header
required

Path Parameters

id
string<uuid>
required

Body

email
string
required

Invite user by email address.

Minimum length: 1

Response

When request is accepted. Returns a hypermedia 'Link' object of the user to be invited.

id
string | null
href
string | null
relation
string | null
method
string | null
default:GET
I