API Reference

Invite a new API user to Canopy

post
https://Contact sales to enable your sandbox/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.

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

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

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.

string
required

The email address of this API User.

string
required

The first name of the API User.

string
required

The last name of the API User.

string

Phone number of API user

Responses

401

Unauthorized.

403

Forbidden.

422

Invalid input.

429

Too many requests.

default

Unexpected Error.

Updated 4 months ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago