Skip to main content
POST
Invite user

Authorizations

Authorization
string
header
required

All of WotNot's APIs use Bearer token authentication. Send your account token as Bearer <token>. You can find it in Settings > Account Settings > Developer. Keep it on your server: anyone who has it can call the API as your account.

Path Parameters

account_id
string
required

The ID of your WotNot account.

Body

application/json

The user to invite and the role to give them.

user
object
required

The user to invite.

notify_user
string
required

Whether to notify the user about the invitation, for example "true".

Example:

"true"

Response

The user was invited. Returns their invitation_link and status.

The link the user opens to create their account. {{customer_portal_domain}} stands in for your portal's domain, and {{invitation_key}} for the user's invitation key.

Example:

"{{customer_portal_domain}}/create-your-account?invitation_key={{invitation_key}}"

ok
boolean
required

true when the request worked. Errors return false.

Example:

true

status
string
required

The invitation's status, for example invited.

Example:

"invited"

Last modified on October 23, 2026