Archive

API Reference

V1

Customers

Archive a customer

client.v1.customers.archive(CustomerArchiveParamsbody, RequestOptionsoptions?): dataIDCustomerArchiveResponse

post/v1/customers/archive

Archive a customer Note: any alerts associated with the customer will not be triggered.

Parameters

bodyidstringCustomerArchiveParams

Hide ParametersShow Parameters

idstring

formatuuid

Returns

CustomerArchiveResponse

Hide ParametersShow Parameters

dataidstringID

HTTPTypeScriptPythonGoRubyTerraform

import Metronome from '@metronome/sdk';

const client = new Metronome({
  bearerToken: 'My Bearer Token',
});

const response = await client.v1.customers.archive({ id: '8deed800-1b7a-495d-a207-6c52bac54dc9' });

console.log(response.data);

200 Example

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  }
}