Skip to content

Add Customer Flag

Overview

Use the AddCustomerFlag endpoint to add a flag to a customer. Flags indicate specific states or conditions for a customer, such as when a partner is actively processing a customer data.

Endpoint

POST https://api.brij.fi/brij.core.v1.partner.Service/AddCustomerFlag

Request Body

{
  "customerId": "cust_abc123xyz",
  "flagType": "FLAG_TYPE_PARTNER_PROCESSING"
}

Request Parameters

Field Type Required Description
customerId string Yes Unique identifier for the customer
flagType string Yes Type of flag to add (see Flag Types)

Flag Types

Value Description
FLAG_TYPE_PARTNER_PROCESSING Indicates the partner is actively processing the customer. Prevents new order creation.

Response

{
  "flagId": "flag_xyz789abc"
}
Field Type Description
flagId string Unique identifier for the created flag

Error Responses

Status Code Description
400 Invalid request parameters
401 Invalid or missing API key
404 Customer or partner not found
500 Internal server error

Examples

Example 1: Mark Customer as Being Processed

Flag a customer to indicate that your partner service is actively processing them:

{
  "customerId": "cust_abc123xyz",
  "flagType": "FLAG_TYPE_PARTNER_PROCESSING"
}