Delete a custom field | Solvimon

Requires the CUSTOM_FIELD.DELETE permission.

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

versionstringRequiredDefaults to 1

version

resourceIdstringRequiredDefaults to

The ID of the resource to be requested.

object_typestring or nullRead-only

idstring or nullRead-only

referencestringformat: "^\S+$"0-256 characters

namestring or null

descriptionstring or null

resource_typeenum

multiple_valuesboolean or null

unique_valueboolean or null

copy_value_to_invoiceboolean or null

integration_idstring

The resource ID of the integration.

integration_referencestringformat: "^\S+$"0-256 characters

The reference of the integration.

typeenum or null

Allowed values:

enum_valueslist of strings or null

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

500

Internal Server Error

1	curl -X DELETE https://test.api.solvimon.com/v1/custom-fields/ \
2	-H "X-API-KEY: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"object_type": "custom_field",
3	"id": "cf_9a8b7c6d5e4f3a2b1c0d",
4	"reference": "customer_custom_field_01",
5	"name": "Customer Loyalty Tier",
6	"description": "Indicates the loyalty tier assigned to the customer",
7	"resource_type": "PLATFORM",
8	"multiple_values": false,
9	"unique_value": true,
10	"copy_value_to_invoice": false,
11	"integration_id": "int_1234567890abcdef",
12	"integration_reference": "loyalty_tier_integration",
13	"type": "STRING",
14	"enum_values": [
15	"Bronze",
16	"Silver",
17	"Gold",
18	"Platinum"
19	]
20	}