customers

Archive a customer

Requires the CUSTOMER.UPDATE permission.

post/v{version}/customers/{resourceIdOrReference}/archive

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/customers/{resourceIdOrReference}/archive
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

resourceIdOrReferencestring required

The ID or reference of the resource.

Headers

x-platform-idstring

Platform ID.

Response

OK

object_typestring nullable
idstring nullable
created_atstring nullable
parent_customer_idstring nullable

The parent of the customer. Only returned when there is a single parent.

parent_customer_idsstring[] nullable

A list of parents of the customer. Will also be returned if there is a single parent.

referencestring

A custom reference assigned to the customer.

status'DRAFT' | 'ACTIVE' | 'ARCHIVED' | 'DEPRECATED' | 'CLOSED'
timezonestring nullable
type'ORGANIZATION' | 'INDIVIDUAL'

The type of customer entity.

emailstring nullable

The email of the customer.

localestring nullable

The locale of the customer. Format is language-country (like en-US).

processing_onlyboolean nullable
rolesCustomerRolesItems[] nullable

Changes

No recorded changes to this operation across all 1 revision of this API.