Invite a new API user to Canopy

Time Status User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

Body of request to invite new API user. Checks permissions of invite-creator.

role
number
required
Defaults to 1
Assign a role to users to dictate permissions and API access level . Contact our team for a full list of options.

email
string
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

``200 Successfully invited a new user

``401

Unauthorized.

``403

Forbidden.

``422

Invalid input.

``429

Too many requests.

``default

Unexpected Error.

Updated 6 months ago


ShellNodeRubyPHPPython

Bearer

Base URL

https://Contact sales to enable your sandbox/api_users


xxxxxxxxxx

curl --request POST \

--url https://contact/%20sales%20to%20enable%20your%20sandbox/api_users \

--header 'accept: application/json' \

--header 'content-type: application/json' \

--data '{"role":1}'  

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

application/json

``200

Updated6 months ago