Delete a custom field option

DELETE 
/api/custom-field-options/{id}

Required permissions:

• settings.company: allows deleting custom field option resources.

warning

Requires "Custom Fields" feature to be enabled.

Request

Path Parameters

id integerrequired

Possible values: Value must match regular expression [0-9]+

The ID of the custom field option to delete

Header Parameters

Wethod-Company stringrequired

The company you want to interact with

Wethod-Version stringrequired

The API version you want to use

Responses

200

Custom field option successfully deleted.

400

Validation failed

application/json

Schema

Schema

headers

object

oneOf

ResponseHeaderBag
content string
version string
status_code integer
status_text string
charset string
callback string
encoding_options integer

Default value: 64

key string

Error unique key

message string

Human-readable message describing the error

failures

object[]

List of validation errors

Array [

field string

Name of the field causing the error

message string

Human-readable description of the error

]

Example (from schema)

{
  "headers": {},
  "content": "string",
  "version": "string",
  "status_code": 0,
  "status_text": "string",
  "charset": "string",
  "callback": "string",
  "encoding_options": 64,
  "key": "invalid_data",
  "message": "You provided invalid data. Check 'failures' for details.",
  "failures": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

headers

object

oneOf

ResponseHeaderBag
content string
version string
status_code integer
status_text string
charset string
callback string
encoding_options integer

Default value: 64

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "headers": {},
  "content": "string",
  "version": "string",
  "status_code": 0,
  "status_text": "string",
  "charset": "string",
  "callback": "string",
  "encoding_options": 64,
  "key": "string",
  "message": "string"
}

403

Forbidden

application/json

Schema

Schema

headers

object

oneOf

ResponseHeaderBag
content string
version string
status_code integer
status_text string
charset string
callback string
encoding_options integer

Default value: 64

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "headers": {},
  "content": "string",
  "version": "string",
  "status_code": 0,
  "status_text": "string",
  "charset": "string",
  "callback": "string",
  "encoding_options": 64,
  "key": "string",
  "message": "string"
}

404

Not found

application/json

Schema

Schema

headers

object

oneOf

ResponseHeaderBag
content string
version string
status_code integer
status_text string
charset string
callback string
encoding_options integer

Default value: 64

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "headers": {},
  "content": "string",
  "version": "string",
  "status_code": 0,
  "status_text": "string",
  "charset": "string",
  "callback": "string",
  "encoding_options": 64,
  "key": "not_found",
  "message": "string"
}

412

Precondition failed

application/json

Schema

Schema

headers

object

oneOf

ResponseHeaderBag
content string
version string
status_code integer
status_text string
charset string
callback string
encoding_options integer

Default value: 64

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "headers": {},
  "content": "string",
  "version": "string",
  "status_code": 0,
  "status_text": "string",
  "charset": "string",
  "callback": "string",
  "encoding_options": 64,
  "key": "precondition_failure",
  "message": "string"
}

Loading...