latestOpenAPI 3.1.02026-08-10295186.7 KB

ec696334ff35

Catalogs

Replace Start

Beta. Catalog replace is a Beta feature and can change. Send the Batch-Beta: catalog-replace header on each call. <br/><br/>Opens a replace session on an existing catalog. A replace changes the entire contents of a catalog, and optionally its schema, in one atomic operation. Batch adds the new items to a hidden revision. The current revision continues to serve reads at the same time. Thus campaigns do not see an empty or a partly filled catalog. <br/><br/>Send the new items to /catalogs/replace/items. Then apply them with /catalogs/replace/complete, or discard them with /catalogs/replace/cancel. Each catalog can have only one open session at a time. The response gives a replace_token. Send this token in each subsequent call to identify the session.

post/catalogs/replace/start

Headers

X-Batch-Projectstring required

The unique project key, identifying a project on the Batch platform

Batch-Betastring required

Value of the Batch-Beta header. It is a comma-separated list of Beta contract flags. Thus one request can opt into more than one Beta contract at the same time (first-flag, second-flag). Flags are lowercase and case-sensitive, and the order does not matter. Batch rejects an unknown flag with a 400 on any endpoint. When a contract becomes generally available, Batch continues to accept its flag but the flag has no more effect. Thus you never need to remove it.

Beta opt-in. This endpoint is in Beta. It accepts only requests that carry the catalog-replace flag. Batch rejects a request without the flag with a 400.

Request body

namestring required

Identifier of the existing catalog to replace.

Response

The replace session is open.

replace_tokenstring required

Token that identifies the replace session. Send it in each subsequent replace call.