POST
/
partner
/
v1
/
userinvites
/
This endpoint will return a 400 Status Code in case the email address provided is already in use

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

email
string
required

E-Mail of the user to invite

Minimum length: 1
company
string
required

UUID of the company that the user is going to be part of

success_url
string
required

Success URL - the user will be redirected here after successfully completing authentication flow

Minimum length: 1
failure_url
string
required

Failure URL - the user will be redirected here if either the flow was cancelled or not completed for any other reason

Minimum length: 1
id
string
Minimum length: 1
first_name
string

First name of the user

Minimum length: 1
last_name
string

Last name of the user

Minimum length: 1

Response

201 - application/json
email
string
required

E-Mail of the user to invite

company
string
required

UUID of the company that the user is going to be part of

success_url
string
required

Success URL - the user will be redirected here after successfully completing authentication flow

failure_url
string
required

Failure URL - the user will be redirected here if either the flow was cancelled or not completed for any other reason

invite_url
string
required

Invite URL - Redirect your User to this URL for tem to complete the onboading process

expiry
string
required

Expiry date/time of the request. After this timestamp is expired, users will have to be re-registered with a new invite

status
string
required

Current status of the User invite

id
string
first_name
string

First name of the user

last_name
string

Last name of the user