appDeleteCustomField

Requires at least one of the permissions customers:customer:read, payments:collection:read, products:product:read, purchase:debit_note:read, purchase:grn:read, purchase:payment:read, purchase:purchase_invoice:read, purchase:purchase_order:read, sales:credit_note:read, sales:quote:read, sales:sales_invoice:read, sales:sales_order:read, sales:shipment:read or suppliers:supplier:read.

Delete one of the calling app's own custom fields that no record holds a value for. Needs write_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 AppDeleteCustomField($id: ID!) {
  appDeleteCustomField(id: $id)
}

cURL

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

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "appDeleteCustomField": true
  }
}

appDeleteCustomField(
  id: ID!
): Boolean!

Arguments

appDeleteCustomField.id ● ID! non-null scalar

The app's field.

Type

Boolean scalar

The Boolean scalar type represents true or false.