Nudgescribe API Reference
APIs
API types
  • Authentication
  • Content
  • Campaign
APIs
API types
  • Authentication
  • Content
  • Campaign
  1. Customers
  • Nudgescribe API
  • Authentication
    • Authentication
    • Authenticate
      POST
    • Re-Authenticate
      GET
  • Content
    • Customers
      • Customer Management
      • Upload and Validate Customer Data
        POST
      • Get pages
        POST
      • Get Customers
        POST
      • Update Customers
        PATCH
      • Delete Customers
        DELETE
    • Customer Groups
      • Customer Groups
      • Create Customer Group
      • Get Customer Groups
      • Update Customer Group
      • Delete Customer Group
    • Customer Profile Fields
      • Customer Profile Fields
      • Create a Custom Profile Field
      • Get Customer Profile Fields for a Workspace
      • Update Custom Fields
      • Delete Custom Fields
  • Campaigns
    • Campaigns and Campaign Messages
    • Get All Accounts Campaigns
      POST
    • Publish Messages to Secure Storage
      POST
    • Retrieve Published Messages
      POST
    • Get Campaign Messages Pages
      POST
  1. Customers

Upload and Validate Customer Data

POST
https://client-api.dev.nudgescribe.com/v1/customer/check
ContentCustomersCustomer ManagementCustomerValidationCustomer DataValidate
Comprehensive validation endpoint that verifies both CSV headers and customer data against your workspace's field configuration before upload. This ensures data quality and prevents upload failures.
Provides pre-upload validation to catch data issues early, ensuring your customer data meets all requirements before committing to the database.

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 Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://client-api.dev.nudgescribe.com/v1/customer/check' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "data_file": "title,gender,language,first_name,last_name,age,unique_id\nMr,M,english,James,Wilson,34,CU001847\nMs,F,spanish,Isabella,Rodriguez,28,CU002951\nDr,M,french,Pierre,Dubois,45,CU003672\nMrs,F,german,Anna,Müller,31,CU004385\nMr,M,japanese,Hiroshi,Tanaka,39,CU005129\nMs,F,portuguese,Lucia,Santos,26,CU006843\nProf,M,mandarin,Wei,Zhang,52,CU007256\nMrs,F,italian,Giulia,Rossi,33,CU008574\nMr,M,arabic,Omar,Al-Ahmad,41,CU009682\nMs,F,dutch,Emma,Van Der Berg,29,CU010397",
  "customer_group_id": "your-customer-group-id",
  "workspace_id": "your-workspace-id"
}'
Response Response Example
200 - Example 1
{
    "header_check": {
        "passed": true,
        "missing_fields": [],
        "added_fields": []
    },
    "data_check": "Data is clean to upload"
}
Modified at 2025-10-29 13:19:27
Previous
Customer Management
Next
Get pages
Built with