Create, Delete and List Custom Fields

Use these API endpoints to create a new custom field or delete or list existing custom fields for a specified subcompany. You need to provide the subcompany ID in the URL path and the takeover secret must be included in the header.

Create Custom Fields

This API endpoint enables you to create new custom fields for a specified subcompany. Besides providing the subcompany ID in the URL path and the takeover secret in the header, make sure you include the custom field details in the JSON body.

Create Custom Fields

POSThttps://v3-api.proto.cx/api/platform/v1/custom-fields/{subcompany_id}/create-custom-field

Path parameters

subcompany_id*Subcompany Id

Header parameters

Body

application/json

entity*CustomFieldEntityEnum

customerticketlivechat

type*CustomFieldType

textnumberbooleanselectdatetime

name*Name

descriptionDescription

stringnull

select_optionsSelect Options

array of stringnull

default_valueDefault Value

stringnull

Response

200404422

Successful Response

Body

application/json

id*Id

entity*CustomFieldEntityEnum

customerticketlivechat

type*CustomFieldType

textnumberbooleanselectdatetime

name*Name

description*Description

stringnull

select_options*Select Options

array of stringnull

default_value*Default Value

stringnull

Request

JavaScriptCurlPython

const response = await fetch('https://v3-api.proto.cx/api/platform/v1/custom-fields/{subcompany_id}/create-custom-field', {
    method: 'POST',
    headers: {
      "authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "entity": "customer",
      "type": "text",
      "name": "text"
    }),
});
const data = await response.json();

Response

200422

{
  "id": "text",
  "entity": "customer",
  "type": "text",
  "name": "text",
  "description": "text",
  "select_options": [
    "text"
  ],
  "default_value": "text"
}

Delete Custom Fields

This API endpoint enables you to create new custom fields for a specified subcompany. Besides providing the subcompany ID in the URL path and the takeover secret in the header, the request body should contain the IDs of the custom fields to be deleted.

Delete Custom Fields

DELETEhttps://v3-api.proto.cx/api/platform/v1/custom-fields/{subcompany_id}/custom-field/{custom_field_id}/delete-custom-fields

Path parameters

subcompany_id*Subcompany Id

Header parameters

Body

application/json

ids*Ids

Response

200404422

Successful Response

Body

application/json

successSuccess

Request

JavaScriptCurlPython

const response = await fetch('https://v3-api.proto.cx/api/platform/v1/custom-fields/{subcompany_id}/custom-field/{custom_field_id}/delete-custom-fields', {
    method: 'DELETE',
    headers: {
      "authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ids": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

200422

{
  "success": true
}

List Custom Fields

Use this API endpoint to list all custom fields for a specified subcompany. You'll only need the subcompany id in the URL path and takeover secret in the header.

List Custom Fields

GEThttps://v3-api.proto.cx/api/platform/v1/custom-fields/{subcompany_id}/list-custom-fields

Path parameters

subcompany_id*Subcompany Id

Header parameters

Response

200404422

Successful Response

Body

application/json

custom_fields*Custom Fields

Request

JavaScriptCurlPython

const response = await fetch('https://v3-api.proto.cx/api/platform/v1/custom-fields/{subcompany_id}/list-custom-fields', {
    method: 'GET',
    headers: {
      "authorization": "text"
    },
});
const data = await response.json();

Response

200422

{
  "custom_fields": [
    {
      "id": "text",
      "entity": "customer",
      "type": "text",
      "name": "text",
      "description": "text",
      "select_options": [
        "text"
      ],
      "default_value": "text"
    }
  ]
}