Rollback

Overview

The rollback endpoint generates virtual changes that represent the state of your Zendesk configuration before a previous apply operation ran. This lets you reverse changes by restoring the original configuration values.

Request

POST /v1/apply/rollback/:operationId

Requires READ_WRITE API key permission. The operationId is the identifier of the apply operation you want to reverse (returned in the response from POST /v1/apply and listed in GET /v1/apply/history).

curl -X POST https://api.configly.app/v1/apply/rollback/op_abc123 \
  -H "Authorization: Bearer cly_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "connectionId": "your_connection_id"
  }'

What rollback does

The rollback endpoint creates new virtual changes that represent the state of each affected object before the apply operation ran. These appear in your virtual changes list like any other staged change. The endpoint does not push anything to Zendesk directly.

Completing a rollback

After generating rollback changes, follow the standard apply flow to push them to Zendesk:

1. Review the generated virtual changes using GET /v1/virtual-changes.
2. Preview the rollback with POST /v1/apply/preview.
3. Apply the rollback with POST /v1/apply, providing a changeReason (for example, "Rolling back operation op_abc123").

This two-step design gives you a chance to inspect the rollback changes before they reach your live Zendesk instance. You can also selectively apply only some of the rollback changes using the changeIds parameter on the apply endpoint.

Error codes

For applying changes, see Apply changes.