Suggestions

close search

Field Value Management

Create a field value

URL: https://api.stringeex.com/v1/fieldvalue

HTTP method: POST

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see StringeeX API REST Authentication

POST data (body):

{
    "object_id": "ct_4u94ae6gcg4olft8",
    "object_type": "contact",
    "is_system_field": "0",
    "field_id": "cf_icsdveixt6udyj6i",
    "field_key": "email",
    "field_value":"tytv@stringee.com"
}

Response:

{
    "id": "fv_0q40co2i3ft4jlsq",
    "r": 0,
    "msg": "Success"
}

Update a field value

URL: https://api.stringeex.com/v1/fieldvalue/fv_0q40co2i3ft4jlsq

HTTP method: PUT

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see StringeeX API REST Authentication

PUT data (body):

{
    "object_id": "ct_4u94ae6gcg4olft8",
    "object_type": "contact",
    "is_system_field": "0",
    "field_id": "cf_icsdveixt6udyj6i",
    "field_key": "email",
    "field_value":"tytv@stringeex.com"
}

Response:

{
    "id": "fv_0q40co2i3ft4jlsq",
    "r": 0,
    "msg": "Success"
}

Delete a field value

URL: https://api.stringeex.com/v1/fieldvalue/fv_3tiwn6mhmy2nvvbd

HTTP method: DELETE

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see Authentication

Response:

{
    "r": 0,
    "msg": "Delete success"
}

List field values

URL: https://api.stringeex.com/v1/fieldvalue?object_type=OBJECT_TYPE&object_id=OBJECT_ID

HTTP method: GET

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see StringeeX API REST Authentication

Sample request:

GET /v1/fieldvalue?object_type=contact&object_id=CTLP51338G HTTP/1.1
Host: https://api.stringeex.com
X-STRINGEE-AUTH: json_web_token
Accept: application/json

Sample response:

{
    "data": {
        "contact": {
            "chat_visitor_id": [
                {
                    "id": "10cd985d40072e4aab77f9c0fe64277e",
                    "portal": "PT8LB2FD3Q",
                    "object_id": "CTLP51338G",
                    "object_type": "contact",
                    "is_system_field": 1,
                    "field_id": "-1",
                    "field_key": "chat_visitor_id",
                    "field_value": "3404399646293876",
                    "created": 0,
                    "updated": 0
                }
            ],
            "email": [
                {
                    "id": "2e60fb9a965d2bb9b540b9908c4e231a",
                    "portal": "PT8LB2FD3Q",
                    "object_id": "CTLP51338G",
                    "object_type": "contact",
                    "is_system_field": 1,
                    "field_id": "1",
                    "field_key": "email",
                    "field_value": "dung@stringee.com",
                    "created": 1596419549,
                    "updated": 0,
                    "field_name": "email"
                }
            ],
            "phone": [
                {
                    "id": "f9ed80e005d1a3833daab98fd21e3e32",
                    "portal": "PT8LB2FD3Q",
                    "object_id": "CTLP51338G",
                    "object_type": "contact",
                    "is_system_field": 1,
                    "field_id": "2",
                    "field_key": "phone",
                    "field_value": "84379361752",
                    "created": 1596419556,
                    "updated": 0,
                    "field_name": "phone"
                }
            ],
            "lead_status": [
                {
                    ...
                }
            ],
            ...
        }
    },
    "r": 0,
    "msg": "Success"
}

Search field value

URL: https://api.stringeex.com/v1/search_fieldvalue

HTTP method: GET

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see StringeeX API REST Authentication

POST data:

{
    "object_type": "contact",
    "is_system_field": 1,
    "field_id": "2",
    "field_value": "84909982668"
}

Response:

{
    "data": [
        {
            "id": "ct_4vhahl5clonhjek2",
            "portal": "pt_zdm328wwmn3pizy0",
            "name": "Đậu Huy",
            "job_title": "CEO",
            "company": "co_1ss3ywd0owcj2t2p",
            "avatar": null,
            "about": "Điều hành chung",
            "created": 1543635514
        }
    ],
    "r": 0,
    "msg": "Success"
}