POST
Exclude a customer
Company space For: Manager · Permission: discount_campaign_restrictions.create Conditions
  • The campaign must not be archived.
  • The customer must be one of the company’s customers and not be deleted.
  • A customer that is already excluded cannot be excluded again.
What else happens
  • The customer is excluded from the campaign (status 201).
  • If the customer had been excluded and the exclusion was lifted, that exclusion is restored instead of a new one being created (status 200).
Part of Choose who gets a campaign.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaign
string
required

Identifier of the discount campaign (27-character KSUID string).

Query Parameters

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, discount_campaign_id, customer_id, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Body

application/json
customer_id
integer
required

Customer to exclude from the campaign (27-character KSUID string). Required; must be an existing customer of the company.

Response

Resource (only with response=resource).

id

Identifier of the exclusion (27-character KSUID string).

discount_campaign_id

Identifier of the campaign the customer is excluded from (27-character KSUID string).

customer_id

Identifier of the excluded customer (27-character KSUID string).

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).