Delink Customer

post

https://{host}/v2/partnerProgram/deLinkCustomer

Lets you remove a customer from one or more partner programs.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This API is used to Delink customer from Partner Program.

👍
Note

For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call.

Example request

curl --location 'https://eu.api.capillarytech.com/v2/partnerProgram/deLinkCustomer' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <YOUR_AUTH_TOKEN>' \
--data '{
    "deLinkCustomers": [
        {
            "customer": {
                "mobile": "919800000000"
            },
            "deLinkFromPartnerPrograms": [
                {
                    "partnerProgramName": "1stProgram",
                    "configAttributes": [
                        {
                            "name": "delinkReason",
                            "value": "CustomerRequested"
                        }
                    ]
                },
                {
                    "partnerProgramName": "p3e1"
                }
            ]
        }
    ]
}'

Prerequisites

Authentication: Basic or OAuth authentication
Partner program access group

Resource information


URI	/v2/partnerProgram/deLinkCustomer
HTTP Method	POST
Pagination	No
Batch support	No
Rate limit information	None

Body parameters

Field	Type	Required	Description
deLinkCustomers	array	Yes	List of customers to delink from partner programs.
.customer	object	Yes	Customer identification details. At least one identifier is required.
..id	integer	Conditional	Customer's internal Capillary ID. Any one identifier is required.
..mobile	string	Conditional	Customer's mobile number. Any one identifier is required.
..email	string	Conditional	Customer's email address. Any one identifier is required.
..externalId	string	Conditional	Customer's external identifier. Any one identifier is required.
.deLinkFromPartnerPrograms	array	Yes	List of partner programs to delink the customer from.
..partnerProgramName	string	Yes	Name of the partner program to delink from.
..configAttributes	array	Optional	Loyalty configuration attributes to capture for this delink. Each attribute is stored against the customer's enrollment and returned by the Get customer activity history API, and echoed back in this API's own response. Each `name` must match a loyalty configuration attribute configured for the partner program, can appear only once in the request, and must have a non-blank `value`.
...name	string	Conditional	Name of the loyalty configuration attribute. Required for each attribute in the array.
...value	string	Conditional	Value of the loyalty configuration attribute. Required for each attribute in the array. There is no character limit for this parameter.

API Quick Reference

POST /v2/partnerProgram/deLinkCustomer
   └─ DeLinkPartnerProgramBatch
       └─ deLinkCustomers[] (array, required)
           ├─ customer (object, required)
           │   ├─ id (integer)
           │   ├─ mobile (string)
           │   ├─ email (string)
           │   └─ externalId (string)
           └─ deLinkFromPartnerPrograms[] (array, required)
               ├─ partnerProgramName (string, required)
               └─ configAttributes[] (array)
                   ├─ name (string)
                   └─ value (string)

Example response

{
    "deLinkCustomers": [
        {
            "customer": {
                "id": 382741349,
                "mobile": "919800000000",
                "email": "[email protected]",
                "externalId": "X919800000000",
                "status": {
                    "status": true,
                    "code": 1000,
                    "message": "Customer successfully retrieved"
                }
            },
            "deLinkFromPartnerPrograms": [
                {
                    "partnerProgramName": "1stProgram",
                    "configAttributes": [
                        {
                            "name": "delinkReason",
                            "value": "CustomerRequested"
                        }
                    ],
                    "partnerDeLinkStatus": {
                        "status": true,
                        "code": 200,
                        "message": "Success"
                    }
                },
                {
                    "partnerProgramName": "p3e1",
                    "partnerDeLinkStatus": {
                        "status": true,
                        "code": 200,
                        "message": "Success"
                    }
                }
            ]
        }
    ],
    "warnings": []
}

Response parameters

Field	Type	Description
deLinkCustomers	array	List of customer delinking results.
.customer	object	Customer identification details and retrieval status.
..id	integer	Customer's internal Capillary ID.
..mobile	string	Customer's mobile number.
..email	string	Customer's email address.
..externalId	string	Customer's external identifier.
..status	object	Status of customer retrieval.
...status	boolean	`true` if customer was found, `false` otherwise.
...code	integer	Status code for customer retrieval. `1000` indicates success.
...message	string	Message describing the customer retrieval result.
.deLinkFromPartnerPrograms	array	List of partner programs and their delinking results.
..partnerProgramName	string	Name of the partner program.
..configAttributes	array	Echoes back the loyalty configuration attributes submitted in the request for this partner program, if any.
...name	string	Name of the loyalty configuration attribute.
...value	string	Value of the loyalty configuration attribute.
..partnerDeLinkStatus	object	Status of delinking the customer from the partner program.
...status	boolean	`true` if delinking succeeded, `false` otherwise.
...code	integer	Status code for the delinking operation. `200` indicates success.
...message	string	Message describing the delinking result.
warnings	array	List of warnings, if any.

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Note

Example request

Prerequisites

Resource information

Body parameters

API Quick Reference

Example response

Response parameters

200200

400400