Update data definition

Updates name and/or description for an existing data definition identified by id. The path also accepts legacy handle URLs and name-id slugs.

PATCH/api/v1/data-definitions/{id}

Updates name and/or description for an existing data definition identified by id. The path also accepts legacy handle URLs and name-id slugs.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?|null

description?string|null

fields?

Map of field handles to typed field definitions.

Response Body

`application/json`

curl -X PATCH "https://loading/api/v1/data-definitions/{id}" \  -H "Content-Type: application/json" \  -d '{    "name": "Customer Account",    "description": "Updated label used by downstream automations",    "fields": {      "firstName": {        "name": "First name",        "type": "text"      },      "email": {        "name": "Email",        "type": "text",        "variant": "url"      },      "loyaltyTier": {        "name": "Loyalty tier",        "type": "select",        "options": [          {            "value": "silver",            "label": "Silver",            "color": "zinc"          },          {            "value": "gold",            "label": "Gold",            "color": "amber"          }        ]      },      "active": {        "name": "Active",        "type": "boolean"      }    }  }'

{
  "id": "8f677f68-466a-49ea-93b9-bb1e7b30dc5d",
  "handle": "customer",
  "url": "/w/acme-growth-team/data/customer-8f677f68-466a-49ea-93b9-bb1e7b30dc5d",
  "name": "Customer",
  "description": "Stores customer profile metadata",
  "fields": {
    "firstName": {
      "name": "First name",
      "type": "text"
    },
    "email": {
      "name": "Email",
      "type": "text",
      "variant": "url"
    },
    "loyaltyTier": {
      "name": "Loyalty tier",
      "type": "select",
      "options": [
        {
          "value": "silver",
          "label": "Silver",
          "color": "zinc"
        },
        {
          "value": "gold",
          "label": "Gold",
          "color": "amber"
        }
      ]
    },
    "active": {
      "name": "Active",
      "type": "boolean"
    }
  },
  "createdAt": "2026-03-05T15:40:00.000Z",
  "updatedAt": "2026-03-05T15:40:00.000Z",
  "deletedAt": null
}

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

{
  "code": "authentication_required",
  "message": "Authentication required. Send Authorization: Bearer <api-key>, x-api-key, or a signed-in session."
}

{
  "code": "insufficient_permissions",
  "message": "This API key does not have data.write permission.",
  "details": {
    "requiredPermission": "data.write"
  }
}

{
  "code": "not_found",
  "message": "The requested resource was not found."
}

{
  "code": "internal_error",
  "message": "An unexpected server error occurred."
}

Update data definition

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`