API Reference

PATCH Updates

You can use the JSON Patch format to partially update some Workiva Platform API resources.

For example, you can update this resource:

{
    "id": "242a56d3cc0742c8abad0820bd318b23",
    "name": "Example Name",
    "description": "Example Description"
}

Using this PATCH document:

[{"op": "replace", "path": "/name", "value": "Updated Name"}]

For this result:

{
    "id": "242a56d3cc0742c8abad0820bd318b23",
    "name": "Updated Name",
    "description": "Example Description"
}

If needed, a single call can provide multiple operations.

📘

Only replace operations are currently supported, and only some resources can be updated using PATCH. You can't update a resource's read-only properties. For more information, refer to endpoint-specific documentation and examples.