v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
customers

Archive a customer contact

Archive an existing customer contact. In the response, the archived field is set as true.

You can restore an archived customer with POST /v3/customers/{customerId}/contacts/{contactId}/restore. There is no change when you archive an archived customer contact.

post/v3/customers/{customerId}/contacts/{contactId}/archive

Path parameters

customerIdstring required

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

Example:{{customer_id}}
contactIdstring required

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

Example:{{customer_contact_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}}

Response

Archive 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