Help Desk

Custom Fields

Custom fields allow additional data to be added to the Helpdesk as required. Custom fields can be defined for independently for users and tickets. For example, a phone number custom field can be added for users.

Read All User Custom Fields

URL <base_uri> / <response_format> /user_custom_fields/
HTTP Method GET
Response Data List of User Custom Field

Data Structure

JSON

                    
    [
        {
            "name": "Company",
            "depends_on_choice": null,
            "required": false,
            "id": 51,
            "choices": null,
            "type": "text",
            "order": 2,
            "visible_to_staff_only": true
        },
        {
            "name": "Phone",
            "depends_on_choice": null,
            "required": false,
            "id": 60,
            "choices": null,
            "type": "number",
            "order": 3,
            "visible_to_staff_only": true
        },
        {
            "name": "Customer Type",
            "depends_on_choice": null,
            "required": false,
            "id": 71,
            "choices": [
                {
                    "text": "Free",
                    "id": 44,
                    "dependant_fields": []
                },
                {
                    "text": "Paid",
                    "id": 43,
                    "dependant_fields": []
                },
                {
                    "text": "Premium",
                    "id": 42,
                    "dependant_fields": [
                        72
                    ]
                }
            ],
            "type": "choice",
            "order": 7,
            "visible_to_staff_only": true
        }
    ]

Read one user custom field

URL <base_uri> / <response_format> /user_custom_field/<id>/
HTTP Method GET
Response Data User Custom Field

Data Structure

JSON

                    
    {
        "name": "Company",
        "depends_on_choice": null,
        "required": false,
        "id": 1,
        "choices": null,
        "type": "text",
        "order": 1,
        "visible_to_staff_only": true
    }

Read All Ticket Custom Fields

URL <base_uri> / <response_format> /ticket_custom_fields/
HTTP Method GET
Response Data List of Ticket Custom Field

Data Structure

JSON

                    
    [
        {
            "name": "Count",
            "depends_on_choice": null,
            "required": true,
            "compulsory_on_completed": true,
            "choices": null,
            "type": "number",
            "id": 55,
            "categories": [
                {
                    "category": 81,
                    "order": 1
                }
            ],
            "visible_to_staff_only": false
        },
        {
            "name": "Example field",
            "depends_on_choice": null,
            "required": true,
            "compulsory_on_completed": false,
            "choices": null,
            "type": "text",
            "id": 69,
            "categories": [
                {
                    "category": 70,
                    "order": 10
                },
                {
                    "category": 72,
                    "order": 10
                }
            ],
            "visible_to_staff_only": true
        },
        {
            "name": "sample",
            "depends_on_choice": null,
            "required": true,
            "compulsory_on_completed": true,
            "choices": null,
            "type": "number",
            "id": 104,
            "categories": [],
            "visible_to_staff_only": true
        }
    ]

Read One Ticket Custom Field

URL <base_uri> / <response_format> /ticket_custom_field/<id>/
HTTP Method GET
Response Data Ticket Custom Field

Data Structure

JSON

                    
    {
        "name": "Notes",
        "depends_on_choice": null,
        "required": false,
        "id": 76,
        "choices": null,
        "type": "text",
        "order": 12,
        "visible_to_staff_only": true
    }

Create New Ticket Custom Field

URL <base_uri> / <response_format> / ticket_custom_fields/
HTTP Method POST
Request Data Create ticket custom field
Response Data Ticket custom field

Data Structure

                        
    {
        "name": "Example Ticket Custom Field",
        "type": "text",
        "compulsory_on_completed": true,
        "required": false,
        "depends_on_choice": null,
        "categories":[7,2,6]
    }
                        
                    
                        
    {
        "name": "Example Field",
        "required": true,
        "compulsory_on_completed": false,
        "type": "dropdown",
        "choices":["A","B"]
        "categories": [1],
        "visible_to_staff_only": true
    }
                        
                    
                        
    {
        "name": "Example field",
        "required": false,
        "compulsory_on_completed": false,
        "type": "number",
        "categories": [1],
        "visible_to_staff_only": true
    }
                        
                    
                        
    {
        "name": "Example field",
        "required": true,
        "compulsory_on_completed": false,
        "type": "multiple option",
        "choices":["A","B","C"],
        "categories": [1],
        "visible_to_staff_only": true
    }
                        
                    
                        
    {
        "name": "Example field",
        "required": false,
        "compulsory_on_completed": false,
        "type": "date",
        "categories": [1],
        "visible_to_staff_only": true
    }
                        
                    
                        
    {
        "name": "Example field",
        "required": true,
        "compulsory_on_completed": false,
        "type": "multiple option",
        "choices":["A","B","C"],
        "categories": [1],
        "visible_to_staff_only": true,
        "depends_on":5,
        "depends_on_value":6
    }

Sample Response JSON

                    
    {
        "name": "Example Ticket Custom Field",
        "depends_on_choice": null,
        "required": false,
        "compulsory_on_completed": true,
        "choices": null,
        "type": "text",
        "id": 36,
        "categories": [
            {
                "category": 7,
                "order": 1
            },
            {
                "category": 2,
                "order": 22
            },
            {
                "category": 6,
                "order": 3
            }
        ],
        "visible_to_staff_only": true
    }

Create New User Custom Field

URL <base_uri> / <response_format> / user_custom_fields/
HTTP Method POST
Request Data Create user custom field
Response Data User custom field

Data Structure

                        
    {
        "name": "Example User Custom Field",
        "type": "text",
        "compulsory_on_completed": true,
        "required": false,
        "depends_on_choice": null
    }
                        
                    
                        
    {
        "name": "Example Field",
        "required": true,
        "compulsory_on_completed": false,
        "type": "dropdown",
        "choices":["A","B"]
        "categories": [1],
        "visible_to_staff_only": true
    }
                        
                    
                        
    {
        "name": "Example field",
        "required": false,
        "compulsory_on_completed": false,
        "type": "number",
        "categories": [1],
        "visible_to_staff_only": true
    }
                        
                    
                        
    {
        "name": "Example field",
        "required": true,
        "compulsory_on_completed": false,
        "type": "multiple option",
        "choices":["A","B","C"],
        "categories": [1],
        "visible_to_staff_only": true
    }
                        
                    
                        
    {
        "name": "Example field",
        "required": false,
        "compulsory_on_completed": false,
        "type": "date",
        "categories": [1],
        "visible_to_staff_only": true
    }
                        
                    
                        
    {
        "name": "Example field",
        "required": true,
        "compulsory_on_completed": false,
        "type": "multiple option",
        "choices":["A","B","C"],
        "categories": [1],
        "visible_to_staff_only": true,
        "depends_on":5,
        "depends_on_value":6
    }

Sample Response JSON

                    
    {
        "name": "Example User Custom Field",
        "depends_on_choice": null,
        "required": false,
        "choices": null,
        "id": 49,
        "type": "text",
        "order": 31,
        "visible_to_staff_only": true
    }