Update Custom Field

Update an existing custom field. Only the fields provided in the request are modified.

PATCH https://api.platica.mx/v1/custom-fields/{fieldId}

URL parameters

Request body

{
  "description": "Tipo de membresía actual del cliente",
  "automatic": true,
  "overwritable": false
}

Body parameters

All parameters are optional, but the request must include at least one.

Editing a select field's options

Send the full option catalog in options. Keep the id of existing options so you don't break values already stored on customers; options without an id are treated as new.

{
  "ordered": true,
  "options": [
    { "id": "nuevo", "label": "Nuevo" },
    { "id": "contactado", "label": "Contactado" },
    { "id": "cerrado", "label": "Cerrado", "archived": true },
    { "label": "Ganado" }
  ]
}

Response

{
  "status": "success",
  "message": "Custom field updated successfully",
  "data": {
    "id": "nivel_de_membresia"
  }
}

Notes

• name and type are immutable after the field is created. To change them, delete the field and create it again.
• In a select field, to "remove" an option mark it as archived: true instead of dropping it from the array: this preserves historical values on customers while hiding the option from new assignments.
• options and ordered only apply to select fields; they are ignored for other types.
• If the field does not exist or has been deleted, the API returns 404.