Skip to main content

Method

PATCH /v1/policies/:id

Path Parameters

id
string
required
Policy ID

Body Parameters

kind
string
cancellation | terms | other
status
string
draft | active
billingCancellationPolicyId
uuid
Billing cancellation policy link
billing_cancellation_policy_id
uuid
Snake-case alias
locale
string
Locale for translation update (required when updating translation fields)
title
string
Translated title
slug
string
Translated slug
descriptionHtml
string
HTML body
description_html
string
Snake-case alias
productId
uuid
Attach/detach product (nullable)
product_id
uuid
Snake-case alias

Headers

Authorization
string
required
Bearer token (e.g. Authorization: Bearer YOUR_API_KEY)
content-type
string
application/json
curl -X PATCH https://api.voyantcloud.com/v1/policies/pol_123 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{ "status": "active", "locale": "en", "title": "Updated Terms" }'
{
  "id": "pol_123",
  "status": "active",
  "title": "Updated Terms"
}