Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Update Customer Status

Lets you update a customer's status label.

put/customers/lookup/status

Query parameters

source'FACEBOOK' | 'WEB_ENGAGE' | 'WECHAT' | 'INSTORE' | 'MARTJACK' | 'TMALL' | 'TAOBAO' | 'JD' | 'ECOMMERCE' | 'WEBSITE' required

Source in which you want to update customer status. For sources that support multiple accounts, you also need to provide the associated account id.

accountIdstring

Account from which the customer's status needs to be updated (Required only for sources with multiple accounts)

use_asyncboolean

Pass true to run loyalty activities in the background, side effects will not be returned in the API response. If false, API will wait for Loyalty activities to complete and then respond to the client with side effects in the API response.

identifierName'mobile' | 'email' | 'externalId' | 'cardnumber' | 'cardExternalId' | 'wechat' | 'martjackId' | 'fbId' required

Identifier used to identify the customer.

identifierValuestring required

Value of the specified identifier.

Headers

X-CAP-API-OAUTH-TOKENstring

Request body

reasonstring required

Reason for the update.

createdOnstring date

Date and time of creation in ISO standard format (YYYY-MM-DDTHH:mm:ssZ).

labelstring required

Predefined label name to update with.

RAW_BODYstring

curl --location --request PUT 'eu.api.capillarytech.com/v2/customers/lookup/status?source=INSTORE&identifierName=email&identifierValue=anjaney.vatsal%40capillarytech.com' \ --header 'X-CAP-API-AUTH-KEY: Qjc0M0ExMDE0MDBBMTUzRDVFRTVFNDI0N0Q5QzAxOEI=' \ --header 'X-CAP-API-AUTH-ORG-ID: 1661' \ --header 'Content-Type: application/json' \ --header 'Authorization: Basic bmVlc3RvcmV0aWxsc3NuZWUyMzoyMDJjYjk2MmFjNTkwNzViOTY0YjA3MTUyZDIzNGI3MA==' \ --header 'Cookie: _cfuvid=4BcdCZZz9edVBFZcJ3.c.cNYIWm7ET7K4ztniWevNbM-1732691082386-0.0.1.1-604800000' \ --data '{ "reason": "testing2", "label": "Active" }'

Response

200

createdIdinteger

Example response

{
  "createdId": 98662653
}