API
APISupport

/clients/{client_id}/invitations

post
https://localhost:4000/clients//invitations

Creates a user account and sends an invitation to complete the enrollment based on the provided activation code.

For a detailed visual of the invitation process please view the provided PDF: Invitation Process

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ICM Client ID

Body Params

Required data to complete the invitation request.

boolean
Defaults to true

Send invitation notification to the user. If false an invitation url will be included in the response

string

Mobile Phone (If not provided 'email' must be used)

string

Master Account Id for the user who created the invitation

string
required

Last Name

individual_data
object
string

ID of the contractor who created the invitation

string
required

First Name

string

External ID

string

Email (If not provided 'mobile_phone' must be used)

string
required

Activation Code

Response

Updated 7 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*

Updated 7 months ago