Update Custom Fields

PATCH

https://client-api.dev.nudgescribe.com/v1/cpf

ContentCustomerProfleCustomer Profile FieldsCPFUpdate

Updates existing custom field properties such as display names, required status, and validation rules while preserving existing customer data.
Enables your application to evolve field definitions as business requirements change, maintaining flexibility in your customer data collection strategy.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠400Bad Request

🟠401Unauthorised

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://client-api.dev.nudgescribe.com/v1/cpf' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "workspace_id": "your-workspace-uuid",
  "changed_fields": [
    {
      "field_id": "field-uuid",
      "display_name": "Customer Category",
      "is_required": false
    }
  ]
}'

Response Example

200 - Example 1

[
    {
        "field_id": "field-uuid",
        "workspace_id": "workspace-uuid",
        "field_key": "customer_type",
        "display_name": "Customer Category",
        "field_type": "ENUM",
        "field_format": null,
        "validation_regex": null,
        "is_required": true,
        "pii": false,
        "is_default": false,
        "order_pos": 1,
        "created_at": "2025-09-11T12:35:57.662Z",
        "updated_at": "2025-09-11T12:35:57.662Z"
    }
]

Modified at 2025-09-12 12:55:30

Get Customer Profile Fields for a Workspace

Delete Custom Fields