This resource contains the custom fields definitions in your portal. The custom fields are returned in the items
property which contains a list of invididual custom field objects.
Each property in the custom field resource corresponds to a property that can be set inside the customFields
property in the Client resource
{
"object": "customFields",
"items": [
{
"id": "71cc12f5-32ce-496f-8fa7-51a5f63b38a4",
"type": "url",
"name": "website",
"order": 7
},
{
"id": "eb1786c5-2baf-4f84-b0d9-61f9f74d09fc",
"type": "address",
"name": "Address",
"order": 13
},
{
"id": "71813f92-3c9f-4161-835e-e0b4b9d4d130",
"type": "email",
"name": "Support Email",
"order": 5
},
{
"id": "7b1f2546-e01f-4279-94c0-0323d004dfdd",
"type": "text",
"name": "Text",
"order": 8
},
{
"id": "8465086b-29e9-4c0f-ae84-1f9246a2bc01",
"type": "number",
"name": "Access Code",
"order": 10
},
{
"id": "7058565d-1753-4ca0-bbf3-3ec95121681b",
"type": "multiSelect",
"name": "Services",
"order": 12,
"options": [
{
"id": "option-19c0a575-e2af-47c2-9090-6b7ce0bad82b",
"label": "Billing",
"color": "rgba(144, 149, 157, 1)"
},
{
"id": "option-b38b1d2a-a05d-4572-a8e3-6565e91f65c8",
"label": "Messaging",
"color": "rgba(0, 0, 0, 1)"
},
{
"id": "option-edf0eff1-9b32-48bb-8a2c-e1288883437c",
"label": "Metrics",
"color": "rgba(150, 75, 0, 1)"
},
{
"id": "option-e70acdf0-a803-449e-8706-a18d54100017",
"label": "File Sharing",
"color": "rgba(204, 0, 0, 1)"
}
]
},
{
"id": "f1eaf544-6da4-457b-bea8-3777a2eeefa7",
"type": "phoneNumber",
"name": "Phone Number",
"order": 3
}
]
}