Suggestions

close search

Field Management

Create a field

URL: https://api.stringeex.com/v1/field/custom

HTTP method: POST

Content-Type: application/json

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

Sample request:

{
    "field_type": "text",
    "field_name": "What is your name?",
    "field_key": "what-is-your-name",
    "field_required": false,
    "object_type": "ticket"
}

Sample Response:

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

List fields

URL: https://api.stringeex.com/v1/field/list?object_type=TYPE

HTTP method: GET

Content-Type: application/json

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

GET params:

Field	Type	Required	Description
object_type	text	Yes	Type of field: company | contact | ticket

Sample request:

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

Sample Response:

{
    "systemFields": [
        {
            "id": 1,
            "object_type": "contact",
            "field_key": "email",
            "field_name": "email",
            "field_type": "text",
            "multiple": 1
        },
        {
            "id": 2,
            "object_type": "contact",
            "field_key": "phone",
            "field_name": "phone",
            "field_type": "text",
            "multiple": 1
        },
        {
            "id": 3,
            "object_type": "contact",
            "field_key": "facebook",
            "field_name": "facebook",
            "field_type": "text",
            "multiple": 1
        }
    ],
    "customFields": [
        {
            "id": 1,
            "object_type": "contact",
            "field_key": "gioi_tinh",
            "field_name": "Giới tính",
            "field_type": "drop_down",
            "multiple": 0,
            "options": [
                {
                    "id": 1,
                    "portal": "stringee",
                    "custom_field_id": 1,
                    "value": "Nam"
                },
                {
                    "id": 2,
                    "portal": "stringee",
                    "custom_field_id": 1,
                    "value": "Nữ"
                }
            ]
        },
        {
            "id": 6,
            "portal": "stringee",
            "object_type": "contact",
            "field_key": "dia_chi",
            "field_name": "Địa chỉ",
            "field_type": "text",
            "multiple": 0
        }
    ],
    "r": -1,
    "msg": ""
}

Get field value from an Object

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

HTTP method: GET

Content-Type: application/json

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

GET params:

Field	Type	Required	Description
object_id	text	Yes	Company ID | Contact ID | Ticket ID
object_type	text	Yes	company | contact | ticket

Response:

{
    "systemFields": [
        {
            "id": 1,
            "object_type": "contact",
            "field_key": "email",
            "field_name": "email",
            "field_type": "text",
            "multiple": 1
        },
        {
            "id": 2,
            "object_type": "contact",
            "field_key": "phone",
            "field_name": "phone",
            "field_type": "text",
            "multiple": 1
        },
        {
            "id": 3,
            "object_type": "contact",
            "field_key": "facebook",
            "field_name": "facebook",
            "field_type": "text",
            "multiple": 1
        }
    ],
    "customFields": [
        {
            "id": 1,
            "object_type": "contact",
            "field_key": "gioi_tinh",
            "field_name": "Giới tính",
            "field_type": "drop_down",
            "multiple": 0,
            "options": [
                {
                    "id": 1,
                    "portal": "stringee",
                    "custom_field_id": 1,
                    "value": "Nam"
                },
                {
                    "id": 2,
                    "portal": "stringee",
                    "custom_field_id": 1,
                    "value": "Nữ"
                }
            ]
        },
        {
            "id": 6,
            "portal": "stringee",
            "object_type": "contact",
            "field_key": "dia_chi",
            "field_name": "Địa chỉ",
            "field_type": "text",
            "multiple": 0
        }
    ],
    "r": 0,
    "msg": "Success"
}

Sample request:

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