Skip to main content
Version: 2025-05-27

Exclusions

Create and manage different sorts of Exclusions on your Target Group. Exclusions prevent certain respondents from entering or completing your survey.

📄️ Create a job to remove all specified entity type respondent exclusions

Creates a job to remove all the specified exclusion respondents for the specified target group ID. This will return an identifier that can be used to retrieve the job execution information, including the status. Only one job can run at a time for a target group. If another job is already running before the endpoint is called for the same target group, a conflict response will be returned. While execution time may vary, removing 10,000 respondents typically takes between 3 and 5 minutes.

📄️ Retrieve a list of excluded access respondent GUIDs (Deprecated)

Retrieve a list of access respondent GUIDs excluded from a given target group. If other APIs or the modern UI are used then only the first 10,000 IDs will be returned with this endpoint. We have replaced this endpoint with the [paginated](#operation/get_target_group_access_respondent_guid_exclusion_list_api_paginated) version. This endpoint will be removed from a future release of the Cint Exchange API but will be supported for the lifetime of this release.

📄️ Upload a list of response IDs (RIDs) to exclude from a given target group (Deprecated)

Creates or updates the list of RIDs to be excluded from a given target group. A maximum of 10ks can be excluded in this container. RIDs can be obtained from the Exchange or legacy Marketplace platforms. If other APIs or the modern UI are used then only the first 10,000 IDs will be returned with this endpoint. You can simultaneously exclude multiple exclusions containers and types (target group, RIDs or Access Respondent GUID for example) at a time up to their specific container limits. We have replaced this endpoint with new endpoints for [adding](#operation/exclusion_create_upload_rids_by_file_job) and [removing](#operation/exclusion_create_remove_all_respondents_job) respondents using jobs, allowing buyers to exclude up to 100,000 IDs in a target group. This endpoint will be removed from a future release of the Cint Exchange API but will be supported for the lifetime of this release.

📄️ Retrieve remove all respondent exclusions job status

Gets the status of a job within the target group to remove all the Respondent ID based exclusions on a target group. Each job will only remove one type of ID. You should be checking this endpoint regularly to see the status of your work. While execution time may vary, removing 10,000 respondents typically takes between 3 and 5 minutes. You should be wary whilst perfoming this action whilst the target group is live as the order of operations will mean that there will be a time with no active Respondent ID based exclusions on the target group.

📄️ Upload a list of access respondent GUIDs to exclude from a given target group (Deprecated)

Creates or updates the list of Access Respondent GUIDs to be excluded from a given target group. A maximum of 10ks can be excluded in this container. Access Respondent GUIDs can be obtained from the legacy Access or BAPI platforms. If other APIs or the modern UI are used then only the first 10,000 IDs will be returned with this endpoint. You can simultaneously exclude multiple exclusions containers and types (target group, Respondent ID or Access Respondent GUID for example) at a time up to their specific container limits. We have replaced this endpoint with new endpoints for [adding](#operation/exclusion_create_upload_rids_by_file_job) and [removing](#operation/exclusion_create_remove_all_respondents_job) respondents using jobs, allowing buyers to exclude up to 100,000 IDs in a target group. This endpoint will be removed from a future release of the Cint Exchange API but will be supported for the lifetime of this release.

📄️ Create a job to upload respondent exclusions by file

Creates a job to upload new respondent exclusions by file for the specified target group ID. The new IDs will be added to the existing ones. The total number of IDs, both existing and new, must not exceed 100,000 IDs. This will return an identifier that can be used to retrieve the job execution information, including the status. Only one job can run at a time for a target group. If another job is already running before the endpoint is called for the same target group, a conflict response will be returned. The file must be in CSV or TXT format, without a header row. Each line should contain a single identifier. Only one single file can be uploaded and the file size must be less than 5MB. While execution time may vary, storing 10,000 new respondents typically takes between 3 and 5 minutes.

📄️ Creates a new Exclusion Group

Exclusion Groups contain target groups from one or more Projects within your account and exclude respondents from all the listed target groups. This endpoint creates a new Exclusion Group and returns the Exclusion Group ID, which can be used to perform further operations on that Exclusion Group. You are allowed to create more than one Exclusion Group with the same tag. A target group can be in multiple Exclusion Groups. You can have up to 100 target groups in an Exclusion Group at any one time.