Archive
const url = 'https://api.shypr.app/rest/crm/customers/archive';const options = { method: 'POST', headers: {'X-API-KEY': '<X-API-KEY>', 'Content-Type': 'application/json'}, body: '{"customerIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"archived":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.shypr.app/rest/crm/customers/archive \ --header 'Content-Type: application/json' \ --header 'X-API-KEY: <X-API-KEY>' \ --data '{ "customerIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "archived": true }'Creates a CustomerBulkArchiveInput resource.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”The new CustomerBulkArchiveInput resource
Archives or publishes each selected customer with ArchiveEntity or PublishEntity, as the single buttons do, and answers for each one. An archive changes no data of the customer, so the input takes ids and no versions.
object
False publishes the customers again.
Archives or publishes each selected customer with ArchiveEntity or PublishEntity, as the single buttons do, and answers for each one. An archive changes no data of the customer, so the input takes ids and no versions.
object
False publishes the customers again.
Responses
Section titled “Responses”CustomerBulkArchiveInput resource created
Archives or publishes each selected customer with ArchiveEntity or PublishEntity, as the single buttons do, and answers for each one. An archive changes no data of the customer, so the input takes ids and no versions.
object
False publishes the customers again.
Example
{ "archived": true}Archives or publishes each selected customer with ArchiveEntity or PublishEntity, as the single buttons do, and answers for each one. An archive changes no data of the customer, so the input takes ids and no versions.
object
False publishes the customers again.
Invalid input
A representation of common errors.
object
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Example
{ "status": 400}A representation of common errors.
object
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Example
{ "status": 400}Forbidden
A representation of common errors.
object
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Example
{ "status": 400}A representation of common errors.
object
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Example
{ "status": 400}An error occurred
Unprocessable entity
object
object
The property path of the violation
The message associated with the violation
The code of the violation
An extra hint to understand the violation
The serialized payload of the violation
object
Example
{ "status": 422}Unprocessable entity
object
object
The property path of the violation
The message associated with the violation
The code of the violation
An extra hint to understand the violation
The serialized payload of the violation
object
Example
{ "status": 422}