SolutionsPricingDocsStart Free
Api

Update Custom Unit

PATCH
/v1/custom-units/{key}

Renames or archives a custom unit. A new name shows everywhere at once; an archived unit takes no new rules.

Authorization

WorkspaceApiKey
X-Api-Key<token>

Workspace-owned Better Auth API key of one environment (Sandbox or Live); it authorizes the Projects of that environment in its Workspace. A Project of the other environment returns 403 ENVIRONMENT_MISMATCH. Never expose it in the browser.

In: header

Path Parameters

key*string
Match^[a-z][a-z0-9_]{0,63}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/custom-units/string" \  -H "Content-Type: application/json" \  -d '{    "projectId": "string"  }'
{  "id": "string",  "key": "string",  "name": "string",  "namePlural": "string",  "archived": true,  "createdAt": "string",  "updatedAt": "string",  "success": true}