Update a document

Update a document's details. At least one field is required. Omitted fields are left unchanged, and null clears description or product_module_definition_key. The key cannot be changed; sending it returns 400. To change the template content, edit the draft on the Root dashboard and publish it.

Documents are shared by your sandbox and production environments, so changing one with an API key requires a production API key. A sandbox API key can read documents but gets 403 here.

Documents are opt-in per organization: unless the org_documents feature flag is enabled for your organization this endpoint returns 404.

Path Params
string
required

Must be a UUID. The unique identifier of the document.

Body Params
string

The display name of the document.

string | null

The description. null clears it.

string | null

The associated product module key. null clears it.

boolean

Whether the document is rendered. A disabled document produces skipped renders.

Responses

400

Validation error, for example an empty body or a key field.

403

The request used a sandbox API key, or the caller is missing the communications:edit permission.

404

No such document, or documents are not enabled for the organization.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json