Sign in
UserInvites

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

<b>Authorization</b>: End user token is required.

<b>User permissions required</b>: CanEditRoles

post/api/v1/userinvites

Request

  • Base URL: https://api.nofrixion.com
  • URL: https://api.nofrixion.com/api/v1/userinvites
  • Auth: API key in header Authorization

Request body

merchantIDstring uuid

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

inviteeEmailAddressstring email required

Email address of the user being invited.

inviteeFirstNamestring nullable

First Name of the user being invited.

inviteeLastNamestring nullable

Last Name of the user being invited.

sendInviteEmailboolean

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

initialRoleIDstring uuid nullable

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.

Response

Returns an OK response.

idstring uuid
inviteeEmailAddressstring nullable
inviterFirstNamestring nullable
inviterLastNamestring nullable
inviteeFirstNamestring nullable
inviteeLastNamestring nullable
inviterEmailAddressstring nullable
merchantIDstring uuid
registrationUrlstring nullable
lastInvitedstring date-time
merchantNamestring nullable
messagestring nullable
userIDstring uuid nullable
isInviteeRegisteredboolean

If true, indicates the invitee's email address corresponds to an existing MoneyMoov user.

initialRoleIDstring uuid nullable

The role ID to automatically assign to the merchant’s very first user. Typically set by the compliance team when the first user is invited to a new merchant.

isAuthorisedboolean

Will be set to true once the invite has met the authorisation requirements.

status'Active' | 'Expired' | 'Accepted' | 'AuthorisationRequired'

Changes

No recorded changes to this endpoint across all 2 revisions of this API.