Resend a user invitation

Resends an invitation email with a temporary password for the specified user.

The user must exist and belong to the specified account when specifying id. Optionally invite a user using a email address instead of user id. Use a default id of all zeros when posting email address payload. Email address invites are only available to client credential grants.

POST /users/{id}/invite

Resend a user invitation

cURL

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

202

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

application/json-patch+jsonapplication/jsonapplication/*+json

email · string · required

Invite user by email address.

Minimum string length: 1

Response

202

application/json

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