Creates a new user invite and optionally sends the invitee an email with the details.

post

https://api-sandbox.nofrixion.com/api/v1/userinvites

Authorization: End user token is required.

User permissions required: CanEditRoles

Body Params

The model holding the details of the user invite to create.

merchantID

uuid

ID of the merchant the user is being invited to. Can be empty if provided by the URL.

inviteeEmailAddress

string

required

length ≥ 1

Email address of the user being invited.

inviteeFirstName

string | null

First Name of the user being invited.

inviteeLastName

string | null

Last Name of the user being invited.

sendInviteEmail

boolean

If set to true an email will be sent to the invitee with instructions on how to accept the invite.

initialRoleID

uuid | null

The role ID to automatically assign to the merchant’s very first user. This property can only be set when the merchant has no users with roles. Typically set by the compliance team when the first user is invited to a new merchant.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200Returns an OK response.