SolutionsPricingDocsStart Free
Api

Rename Benefit Rule

PUT
/v1/benefit-rules/{ruleId}/name

Change the name of a benefit rule. The rule and its terms do not change. A write applies at once. Needs the programs:write key permission.

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

ruleId*string
Match\S
Length1 <= length <= 512

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

application/json

curl -X PUT "https://example.com/v1/benefit-rules/string/name" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "projectId": "string"  }'
{  "success": true,  "data": {    "ruleId": "string",    "name": "string"  }}