v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB

organization-users

Create a user

Create a new user. The currently signed-in user must have the ADMINISTRATOR user role in the BILL organization to perform this operation.

When you create a user, BILL sends an email to the user for them to complete their sign-up. After user sign-up is complete, the user can access features in your BILL organization depending on the user role.

See Organizations and Users in the Guides section for more information, sample requests, and responses.

post/v3/users

Headers

sessionIdstring nullable

API session ID generated with /v3/login

Example:{{session_id}}

devKeystring nullable

Developer key generated with your BILL developer account

Example:{{developer_key}}

Request body

firstNamestring required

User first name

lastNamestring required

User last name

emailstring required

User email address

roleIdstring required

BILL-generated ID of the user role. The value begins with 0po.

If you do not set roleId, the default ADMINISTRATOR user role is assigned to the created user. You can get the list of available user roles with GET /v3/roles.

acceptTermsOfServiceboolean required

Set as true if the user accepts the BILL terms of service

Example request

{
  "firstName": "Clark",
  "lastName": "Billenterson",
  "email": "info@happymusicsupplies.org",
  "roleId": "{{org_user_role_id}}",
  "acceptTermsOfService": true
}

Response

Create a user response

idstring

BILL-generated ID of the user. The value begins with 006.

archivedboolean

Set as true if the user is archived

firstNamestring

User first name

lastNamestring

User last name

emailstring

User email address

createdTimestring date-time

Created date and time

updatedTimestring date-time

Updated date and time