Sign in

v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
partner

Create a user

Create a new user. The new user is created for the organization (organizationId) in the request header.

In the request, set username as a unique alphanumeric value. The value must be 40 characters or fewer. This field is not case-sensitive. Do not set the value as an email address or any PII value. BILL uses this value to uniquely identify each user.

This operation requires partner-level permissions.

  • A sessionId header value generated with API partner login
  • An appKey header value
  • The organizationId of the organization

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

post/v3/partner/users

Headers

sessionIdstring nullable

API session ID generated with /v3/partner/login

Example:{{partner_session_id}}
appKeystring nullable

Application key sent to you by BILL when you create a partner account

Example:{{app_key}}
organizationIdstring nullable

BILL-generated ID of the organization

Example:{{partner_organization_id}}

Request body

firstNamestring required

User first name

lastNamestring

User last name

emailstring required

User email address

roleIdstring

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/partner/roles.

usernamestring required

Username for signing in as the user.

Set username as a unique alphanumeric value. The value must be 40 characters or fewer. This field is not case-sensitive. Do not set the value as an email address or any PII value. BILL uses this value to uniquely identify each user.

externalReferenceIdstring

Reference ID used as an external identifier.

You can set this field as a unique alphanumeric value for your system to refer to the created user.

acceptTermsOfServiceboolean required

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

Example request

{
  "firstName": "Tomato",
  "lastName": "Soupsmith",
  "email": "tsoupsmith@ricecakes.org",
  "roleId": "{{partner_user_role_id}}",
  "username": "tsoupsm!th1",
  "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