# 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.


## Servers
- Public Sandbox: https://sandbox-api.canopyservicing.com (Public Sandbox)
- Protected UAT Sandbox: https://uat-api.canopyservicing.com (Protected UAT Sandbox)
- Production: https://api.canopyservicing.com (Production)


## Authentication methods
- O auth2


## Parameters



### Body: application/json (object)
Body of request to invite new API user. Checks permissions of invite-creator.
- **role** (number)
  Assign a role to users to dictate permissions and API access level . [Contact our team](mailto:devs@canopyservicing.com?subject=API%20Access%20Request) for a full list of options.
- **email** (string(email))
  The email address of this API User.
- **name_first** (string)
  The first name of the API User.
- **name_last** (string)
  The last name of the API User.
- **phone** (string)
  Phone number of API user


## Responses
### 200
Successfully invited a new user

#### Body: application/json (object)
- **status** (string)
  Result of API user creation request

### 401
Unauthorized.

### 403
Forbidden.

### 422
Invalid input.

### 429
Too many requests.

### default
Unexpected Error.


[Powered by Bump.sh](https://bump.sh)