Fielding (Batch)

Creates a job to pause multiple target groups

This endpoint creates a bulk job to pause fielding runs for a list of specified target group IDs. This action will pause the fielding runs for the specified target groups. A target group can only be paused if it is currently in a 'live' state. If a target group is already paused, the system considers the action successful.

To ensure that the same job is not created multiple times, this endpoint uses an Idempotency-Key from the request header. If a job with the same key has already been submitted, the system will not create a new one but will treat the operation as successful and return the same successful response as for a newly created job.

Upon successful submission, the system creates a new bulk job to start the actual processing asynchronously. This means the endpoint returns a response quickly without waiting for the entire bulk operation to complete. If the job is created successfully or if it already existed due to the idempotency key, the endpoint returns a 201 Created status code with the job ID in the Location header.

To check the status of the job, you can use the job ID returned in the Location header with the Retrieve a bulk job status endpoint. The processing of the job will continue even if an operation on an individual target group fails. The final job status will list which target groups were updated successfully and which ones failed.

post/demand/accounts/{account_id}/projects/{project_id}/batch-jobs/pause-fielding-runs-by-target-group-id

Request

Path parameters

account_idinteger required

The account's unique identifier.

Example:101
project_idstring required

The character string representing a unique project ID (ULID format).

Example:01BTGNYV6HRNK8K8VKZASZCFP0

A unique identifier for the project, in ULID format.

Headers

idempotency-keystring required

A shallow unique ID used as part of the deduplication mechanism for mutable operations. We suggest using UUIDv4 or another random string with sufficient entropy to avoid collisions.

Example:01BTGNYV6HRNK8K8VKZASZCFP0

A shallow unique ID used as part of the deduplication mechanism for mutable operations, this header is required.

Request body

target_group_idsTargetGroupID[] required

An array of unique target group identifiers to be processed in a bulk job.

Example request

{
  "target_group_ids": [
    "01BTGNYV6HRNK8K8VKZASZCFP1"
  ]
}

Response

The job was created successfully. Poll the URL in the Location header to track its status.

Changes

No recorded changes to this operation across all 1 revision of this API.