😀Customer

List

Retrieve the contact list via a GET request, and you can filter, sort, and paginate using the query parameters below.

GET https://{API_HOST}/api/v1/contact

According to the Query Parameters parameters for filtering.

curl -X GET
    -H "Content-Type: application/json"
    https://{API_HOST}/api/v1/contact

Query Parameters

Name	Type	Required	Description	Example
page	integer	No	Current page number (starting from 1)	page=2
search	string	No	Name keyword search	search=John
created_at__start	string (datetime)	No	Created time (start)	created_at__start=2023-01-01
created_at__end	string (datetime)	No	Created time (end)	created_at__end=2023-12-31
birth_months	array<integer>	No	Birth months (1–12)	birth_months=1,2
membership_no	string	No	Membership number	membership_no=123456
sponsor_id	string	No	Owner ID	sponsor_id=999
company_ids	array<integer>	No	Company ID	company_ids=1,2,3
tag_ids	array<integer>	No	List of tag IDs	tag_ids=101,102
identity_no	string	No	Identity number	identity_no=A123456789
phone_number	string	No	Phone number	phone_number=0912345678
age__start	integer	No	Age (start)	age__start=20
age__end	integer	No	Age (end)	age__end=40
has_duplicate_number	boolean (0/1)	No	Has duplicate number	has_duplicate_number=1
has_number	boolean (0/1)	No	Has phone number	has_number=1
has_fb_optin	boolean (0/1)	No	Has FB opt-in	has_fb_optin=1
has_valid_fb_optin	boolean (0/1)	No	Has valid FB opt-in	has_valid_fb_optin=1
has_disturb	boolean (0/1)	No	Has do-not-disturb data	has_disturb=1

Response

PROPERTY	TYPE	DESCRIPTION
data	Array of objects	Array of customer data
meta	Object	Pagination information

Retrieve

GET https://{API_DOMAIN}/api/v1/contact/{contact}

URL Parameters

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
contact	True	NULL	Number	Customer ID

curl -X get
    -H "Content-Type: application/json"
    https://{API_HOST}/api/v1/contact/1

Response

Please refer tocontactresponse format.

PROPERTY	TYPE	DESCRIPTION
data	Object	contact

{
    "data": {
        "id": 1,
        "name": "Angelita D'Amore",
        "first_name": "Angelita",
        "last_name": "D'Amore",
        "membership_no": "8771639",
        "identity_no": "418099",
        "gender": 0,
        "birth_at": "1985-08-27",
        "profile_id": 1,
        "profile": {
            "id": 1,
            "phones": []
        },
        "email_contacts": [],
        "cz_cols": [
            {
                "id": 1,
                "value": "19999",
                "category_id": 1
            },
            {
                "id": 4,
                "value": "51",
                "category_id": 1
            },
            {
                "id": 5,
                "value": null,
                "category_id": 1
            }
        ]
    }
}

Create

POST https://{API_HOST}/api/v1/contact

According to the Query Parameters Create using form parameters.

curl -X POST
    -H "Content-Type: application/json"
    '{"first_name":"abc","last_name":"cde"}'
    https://{API_HOST}/api/v1/contact?xxxx

Query Parameters

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
membership_no	false	NULL	String	Membership number
identity_no	false	NULL	String	Identity document
gender	false	NULL	Number	Gender 0: Female 1: Male
first_name	true	NULL	String	Last name
last_name	false	NULL	String	First name
birth_at	false	NULL	Date	Date of birth
cz_cols	false	NULL	Array	Custom fields, parameter types refer to below CzCol Table description
company_ids	false	NULL	Array	Company system number

Response

Please refer tocontactResponse format

{
    "data": {
        "id": 2,
        "name": "abc cde",
        "first_name": "abc",
        "last_name": "cde",
        "membership_no": null,
        "identity_no": null,
        "gender": null,
        "birth_at": null,
        "profile_id": 1,
        "profile": {
            "id": 1,
            "phones": []
        },
        "cz_cols": [
            {
                id: 4,
                value: "123456"
            },
            {
                id: 7,
                value: "apple"
            }
        ],
    }
}

Update

PUT https://{API_HOST}/api/v1/contact/{id}

URL Parameters

PARAMETER	DESCRIPTION
id	Customer ID

curl -X PUT
    -H "Content-Type: application/json"
    '{"first_name":"First","last_name":"Line"}'
    https://{API_HOST}/api/v1/contact/2

Query Parameters

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
membership_no	false	NULL	String	Membership number
identity_no	false	NULL	String	Identity document
gender	false	NULL	Number	Gender 0: Female 1: Male
first_name	false	NULL	String	Last name
last_name	false	NULL	String	First name
birth_at	false	NULL	Date	Date of birth
cz_cols	false	NULL	Array	Custom fields, parameter types refer to below CzCol Table description
tag_ids	false	NULL	Array	Customer tags, pass in customer tag IDs
company_ids	false	NULL	Array	Company system number

Response

Please refer tocontactResponse format

{
    "data": {
        "id": 2,
        "name": "First Line",
        "first_name": "First",
        "last_name": "Line",
        "membership_no": null,
        "identity_no": null,
        "gender": null,
        "birth_at": null,
        "profile_id": 1,
        "profile": {
            "id": 1,
            "phones": []
        },
        "cz_cols": [
            {
                id: 4,
                value: "123456"
            },
            {
                id: 7,
                value: "apple"
            },
            {
                id: 18,
                value:  ["A", "B", "C"]
            }
        ],
        "tag_id": [4, 6]
    }
}

Delete

DELETE https://{API_HOST}/api/v1/contact/{id}

URL Parameters

PARAMETER	DESCRIPTION
id	contactThe system number #ID

curl -X DELETE
    -H "Content-Type: application/json"
    https://{API_HOST}/api/v1/contact/2