Update version content

Updates content for a non-published, non-pending version. Published and pending versions are immutable.

PATCH /v1/policies/{id}/versions/{versionId}

Update version content

cURL

curl --request PATCH \
  --url http://localhost:3333/v1/policies/{id}/versions/{versionId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "content": [
    {
      "type": "heading",
      "attrs": {
        "level": 2,
        "textAlign": null
      },
      "content": [
        {
          "type": "text",
          "text": "Purpose"
        }
      ]
    }
  ]
}
'

200

{
  "versionId": "<string>"
}

Authorizations

X-API-Key · string · header · required

API key for authentication

Path Parameters

id · string · required

Policy ID

Example:

"pol_abc123def456"

versionId · string · required

Policy version ID

Example:

"pv_abc123def456"

Body

application/json

Update content for a policy version

content · object[] · required

Content of the policy version as TipTap JSON (array of nodes)

Example:

[
  {
    "type": "heading",
    "attrs": { "level": 2, "textAlign": null },
    "content": [{ "type": "text", "text": "Purpose" }]
  }
]

Response

200

application/json

Version content updated

versionId · string