v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB

customers

Create a customer contact

Create a new customer contact.

When you create a customer contact, BILL enables the customer to sign in to the BILL web app with the email value and a random password. The signed-in customer can view invoices, make payments, and manage their account.

post/v3/customers/{customerId}/contacts

Path parameters

customerIdstring required

BILL-generated ID of the customer. The value begins with 0cu.

Example:{{customer_id}}

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

Customer first name

lastNamestring

Customer last name

emailstring email required

Customer email address. The value must be unique in the organization.

phonestring

Customer phone number

altPhonestring

Customer alternate phone number. Use this field to sync with your accounting system.

alternateEmailstring email

Customer alternate email address. The customer cannot use this email address to sign in to the BILL web app.

Example request

{
  "firstName": "Adam",
  "lastName": "Mailworth",
  "email": "admin@paperlessband.org",
  "phone": "8889997654"
}

Response

Create a customer contact response

idstring

BILL-generated ID of the customer contact. The value begins with cpu.

archivedboolean

Set as true if the customer contact is archived.

customerIdstring

BILL-generated ID of the customer. The value begins with 0cu.

firstNamestring

Customer first name

lastNamestring

Customer last name

emailstring

Customer email address

phonestring

Customer phone number

altPhonestring

Customer alternate phone number

alternateEmailstring

Customer alternate email address

createdTimestring date-time

Created date and time

updatedTimestring date-time

Updated date and time