v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Engagements

Update Engagement

🔐 This endpoint requires HTTP Bearer authentication. For authenticating with Bearer token, required scopes are: retail_media.engagements(w).

Beta: This endpoint is in beta and may change. Updates the suspension status of an advertiser engagement. When suspended, the engagement's ads will stop serving. When unsuspended, the engagement's ads will resume serving.

patch/v1/engagements/{engagement_id}

Path parameters

engagement_idstring required

The advertiser engagement ID.

The advertiser engagement ID.

Query parameters

keystring required

The key of the index to use.

The key of the index to use.

Request body

is_suspendedboolean required

Whether the engagement is suspended.

Response

Successful Response.

engagement_idstring required

The advertiser engagement ID.

keystring required

The key of the index.

is_suspendedboolean required

Whether the engagement is suspended.