Update customer status

With this endpoint, you can update the account status of an existing customer by customerId.

Authorizations

Authorization

string

header

required

The access token.

Headers

x-fabric-tenant-id

string

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

Example:

"517fa9dfd42d8b00g1o3k312"

x-fabric-request-id

string

A UUID of the request.

Path Parameters

customerId

string

required

A 24-character system-generated ID of the customer. This is returned in the response of the POST /customers endpoint.

Example:

"61a558b1b155125f02be7fb1"

Body

application/json

A sample request to update customer's account status.

status

enum<string>

The status of the customer's account.

Available options:

ACTIVE,

INACTIVE,

BLOCKED

Example:

"ACTIVE"

Response

200

application/json

Customer status update response

The details of customer's status.

type

string

required

A machine-readable code.

Example:

"SUCCESS"

message

string

required

A human-readable message corresponding to type.

Example:

"Success message"

status

enum<string>

The customer's account status.

Available options:

ACTIVE,

INACTIVE,

BLOCKED

Example:

"ACTIVE"