Versions
Manage configuration versions. Create, list, find, and update versions to publish destination, source, and mapping changes to your live deployment.
Manage configuration versions. Create, list, find, and update versions in your account.
Tag Manager containers, tags, triggers, and variables are draft changes. POST /rest/v1/versions accepts includeTagManagers, includeTagManagerTags, includeTagManagerTriggers, and includeTagManagerVariables allowlists for scoped publishing. Selecting a tag, trigger, or variable whose container has never been published publishes that container too, and selecting a deleted container removes its tags, triggers, and variables with it.
Once any include* field lists ids, only the listed changes publish, and every collection you omit or send as [] keeps its published state. Omit every include* field to publish all draft changes.
To check a single entity instead of the whole draft, use GET /rest/v1/versions/draft/status?collection={collection}&entityId={id}. It returns added, modified, removed, or null for that one entity, with the same semantics as GET /rest/v1/versions/draft/diff but without transferring the full change set.
GET/rest/v1/versions
Ours Privacy API key
In: header
Query Parameters
Maximum number of items to return. Defaults to 25; values below 1 are clamped to 1 and values above 100 are clamped to 100.
Opaque pagination cursor from pagination.nextCursor in the previous response. Do not decode or modify it. Malformed cursors return 400 Bad Request.
Filter to only published or unpublished versions.
Case-insensitive substring match on the version name.
Case-insensitive substring match on the version notes.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/rest/v1/versions"{ "entities": [ { "id": "string", "name": "string", "versionNumber": 0, "isPublished": true, "notes": "string", "createdAt": "string", "publishedAt": "string", "publishedByUserId": "string", "publishedByUserName": "string" } ], "pagination": { "nextCursor": "string", "hasMore": true }}POST/rest/v1/versions
Ours Privacy API key
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/rest/v1/versions" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "string", "name": "string", "versionNumber": 0, "isPublished": true, "notes": "string", "createdAt": "string", "publishedAt": "string", "publishedByUserId": "string", "publishedByUserName": "string"}GET/rest/v1/versions/{id}
Ours Privacy API key
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/rest/v1/versions/string"{ "id": "string", "name": "string", "versionNumber": 0, "isPublished": true, "notes": "string", "createdAt": "string", "publishedAt": "string", "publishedByUserId": "string", "publishedByUserName": "string"}PATCH/rest/v1/versions/{id}
Ours Privacy API key
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/rest/v1/versions/string" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "string", "name": "string", "versionNumber": 0, "isPublished": true, "notes": "string", "createdAt": "string", "publishedAt": "string", "publishedByUserId": "string", "publishedByUserName": "string"}POST/rest/v1/versions/{id}/publish
Ours Privacy API key
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/rest/v1/versions/string/publish"{ "id": "string", "name": "string", "versionNumber": 0, "isPublished": true, "notes": "string", "createdAt": "string", "publishedAt": "string", "publishedByUserId": "string", "publishedByUserName": "string"}GET/rest/v1/versions/{id}/snapshot
Ours Privacy API key
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/rest/v1/versions/string/snapshot"{ "id": "string", "versionNumber": 0, "jsonContent": {}}GET/rest/v1/versions/{id}/diff
Ours Privacy API key
In: header
Path Parameters
Query Parameters
Baseline version id to compare the path version against. Omit or pass null for the latest published version. Pass a version UUID to compute a version-vs-version diff.
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/rest/v1/versions/draft/diff"{ "count": 0, "differences": { "destinations": { "added": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "removed": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "modified": [ { "old": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "new": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "changes": [ { "path": "string", "old": "string", "new": "string" } ] } ] }, "sources": { "added": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "removed": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "modified": [ { "old": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "new": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "changes": [ { "path": "string", "old": "string", "new": "string" } ] } ] }, "allowedEvents": { "added": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "removed": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "modified": [ { "old": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "new": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "changes": [ { "path": "string", "old": "string", "new": "string" } ] } ] }, "externalAllowedEventData": { "added": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "removed": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "modified": [ { "old": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "new": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "changes": [ { "path": "string", "old": "string", "new": "string" } ] } ] }, "mappings": { "added": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "removed": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "modified": [ { "old": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "new": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "changes": [ { "path": "string", "old": "string", "new": "string" } ] } ] }, "consentSettings": { "added": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "removed": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "modified": [ { "old": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "new": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "changes": [ { "path": "string", "old": "string", "new": "string" } ] } ] }, "globalDispatchCenters": { "added": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "removed": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "modified": [ { "old": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "new": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "changes": [ { "path": "string", "old": "string", "new": "string" } ] } ] }, "replaySettings": { "added": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "removed": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "modified": [ { "old": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "new": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "changes": [ { "path": "string", "old": "string", "new": "string" } ] } ] }, "tagManagers": { "added": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "removed": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "modified": [ { "old": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "new": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "changes": [ { "path": "string", "old": "string", "new": "string" } ] } ] }, "tagManagerTags": { "added": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "removed": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "modified": [ { "old": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "new": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "changes": [ { "path": "string", "old": "string", "new": "string" } ] } ] }, "tagManagerTriggers": { "added": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "removed": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "modified": [ { "old": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "new": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "changes": [ { "path": "string", "old": "string", "new": "string" } ] } ] }, "tagManagerVariables": { "added": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "removed": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "modified": [ { "old": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "new": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "changes": [ { "path": "string", "old": "string", "new": "string" } ] } ] }, "dataGovernanceRules": { "added": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "removed": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "modified": [ { "old": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "new": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "changes": [ { "path": "string", "old": "string", "new": "string" } ] } ] }, "dataGovernanceEvents": { "added": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "removed": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "modified": [ { "old": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "new": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "changes": [ { "path": "string", "old": "string", "new": "string" } ] } ] }, "experimentSettings": { "added": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "removed": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "modified": [ { "old": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "new": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "changes": [ { "path": "string", "old": "string", "new": "string" } ] } ] }, "experiments": { "added": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "removed": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "modified": [ { "old": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "new": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "changes": [ { "path": "string", "old": "string", "new": "string" } ] } ] }, "experimentVariants": { "added": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "removed": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "modified": [ { "old": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "new": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "changes": [ { "path": "string", "old": "string", "new": "string" } ] } ] }, "shortLinks": { "added": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "removed": [ { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" } ], "modified": [ { "old": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "new": { "id": "string", "name": "string", "type": "string", "summary": "string", "tagManagerId": "string" }, "changes": [ { "path": "string", "old": "string", "new": "string" } ] } ] } }}GET/rest/v1/versions/{id}/status
Ours Privacy API key
In: header
Path Parameters
Value in
- "draft"
Query Parameters
Entity collection the id belongs to. experiments and experimentVariants are not supported — draft experiments never snapshot into a version — but experimentSettings is.
Value in
- "allowedEvents"
- "consentSettings"
- "dataGovernanceEvents"
- "dataGovernanceRules"
- "destinations"
- "experimentSettings"
- "externalAllowedEventData"
- "globalDispatchCenters"
- "mappings"
- "replaySettings"
- "sources"
- "tagManagerTags"
- "tagManagerTriggers"
- "tagManagerVariables"
- "tagManagers"
Id of the entity to check. Most collections use UUIDs; allowedEvents, externalAllowedEventData, mappings, consentSettings, globalDispatchCenters, and replaySettings use slug-like strings.
1 <= lengthResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/rest/v1/versions/draft/status?collection=allowedEvents&entityId=string"{ "collection": "allowedEvents", "id": "string", "status": "added"}POST/rest/v1/versions/{id}/revert
Ours Privacy API key
In: header
Path Parameters
Value in
- "draft"
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/rest/v1/versions/draft/revert" \ -H "Content-Type: application/json" \ -d '{ "entities": [ { "collection": "allowedEvents", "id": "string" } ] }'{ "revertedCount": 0, "restoredCount": 0, "discardedCount": 0, "notFoundCount": 0, "remainingChanges": 0}POST/rest/v1/versions/{id}/abandon
Ours Privacy API key
In: header
Path Parameters
Value in
- "draft"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/rest/v1/versions/draft/abandon"{ "revertedCount": 0, "restoredCount": 0, "discardedCount": 0, "notFoundCount": 0, "remainingChanges": 0}How is this guide?

