deleteCustomField

Requires permission settings:custom-fields:manage.

Deletes a custom field that no record holds a value for; its key can then be reused. A field with values is refused with the record count, and should be archived instead; a field an enabled approval rule tests is refused, naming the rules. Requires permission to manage custom fields.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation DeleteCustomField($id: ID!) {
  deleteCustomField(id: $id)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation DeleteCustomField($id: ID!) {\n  deleteCustomField(id: $id)\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "deleteCustomField": true
  }
}

deleteCustomField(
  id: ID!
): Boolean!

Arguments

deleteCustomField.id ● ID! non-null scalar

The custom field.

Type

Boolean scalar

The Boolean scalar type represents true or false.