Reconciliations

Submit a list of RIDs for positive reconciliation

Submits a CSV file of respondent IDs to be reconciled as completes for a specific project.

This action creates an asynchronous job to process the file. A 202 Accepted response indicates that the file has been successfully queued for processing. You can use the request_id returned in the response body to track the status of the job.

Key behaviors:

  • File Format: The file must be a CSV with no header row. Each line must contain a respondent ID (UUID).
  • File Size: The file can contain up to 100,000 rows.
post/demand/accounts/{account_id}/projects/{project_id}/reconciliations/completes

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.

Query parameters

namestring

The name of the file containing requests to reconcile.

Headers

Idempotency-Keystring

A shallow unique ID used as part of the deduplication mechanism for mutable operations. Value should be UUIDv4.

Example:96C65204-90C2-4DCB-9393-B8226DD50C76
Content-Type'text/csv' | 'application/csv' required

The content type of the request body.

Request body text/csv

string required

Format each line as: RID (UUID). Do not include a header row.

Example request

"0F1CE179-A917-49FF-9D50-B05FC91F7BD4\n75F1404C-65F6-4937-AD2A-588E4F66E07F\n9C23131D-388B-4E03-97B3-CF783E491445"

Response

Accepted reconciliation completes request for processing.

namestring

The name of the submitted reconciliation request

request_idstring ulid

UniqueID generated for the reconciliation request

Example response

{
  "name": "Reconciliation_file_name.csv",
  "request_id": "01F8K8P3Z5KNYR5H0GQZAYGQJ9"
}

Changes

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