Archive a Customer

Use this endpoint to archive a customer.

Overview

Archiving removes the customer from customer lists and lookups. Customer history and linked services are retained. A customer that has proposals cannot be archived and the request returns 409 with code set to CUSTOMER_HAS_PROPOSALS.

What's Next

  • Use GET /customers to confirm the customer no longer appears in lists.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Customer ID to archive.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json