Invite a new API user to Canopy
POST
/api_users
When you create a new API user via this POST request, an email invite will be sent for the new user to join your organization. The email invite includes a link with a unique token that will allow the new user to register to join your team in Canopy.
Body Required
Body of request to invite new API user. Checks permissions of invite-creator.
-
role number Required
Assign a role to users to dictate permissions and API access level . Contact our team for a full list of options.
Default value is
1. -
email string(email) Required
The email address of this API User.
-
name_first string Required
The first name of the API User.
-
name_last string Required
The last name of the API User.
-
phone string
Phone number of API user
POST /api_users
curl \
-X POST https://<your_environment_name>-uat-api.canopyservicing.com/api_users \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"role":3,"email":"marissa@globex.com","name_first":"John","name_last":"Doe","phone":"1-234-567-8900"}'
Request example
{
"role": 3,
"email": "marissa@globex.com",
"name_first": "John",
"name_last": "Doe",
"phone": "1-234-567-8900"
}
Response example (200)
{
"status": "success"
}