Suspend a customer

POST

/customers/{customer_id}/suspend

Suspends an active customer. Requires a master token.

Authorizations

bearerToken|siteContext

bearerToken

Personal access token tied to a user account. Requires the X-Nimbu-Site header to scope requests.

TypeHTTP (bearer)

+

siteContext

Identifier of the site context when authenticating with a personal access token.

TypeAPI Key (header: X-Nimbu-Site)

or

siteToken

Site-scoped API token that already encodes the site context.

TypeHTTP (bearer)

Parameters

Path Parameters

customer_id*

Customer identifier

Typestring

Required

Responses

customer suspended

Content-Type

application/json

{

"status": "string"

}

POST

/customers/{customer_id}/suspend

Playground

Authorization

bearerToken

siteContext

Variables

Key

Value

customer_id*

Samples