Exclusions

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

📄️ Creates a job to remove all respondent exclusions by type

Creates a job to remove all the specified exclusion respondents for the specified Target Group ID. This returns an identifier that can retrieve the job execution information, including the status.

📄️ Delete an Exclusion Group by its ID if it has no associated Target Groups

Deletes a specific exclusion group. **Prerequisite:** You must remove all target groups from an exclusion group before you can delete it. Attempting to delete a group that still contains target groups will result in a failed request with a conflict error.

📄️ Retrieves the project exclusion status for a target group

Retrieves the project-level exclusion status for a single target group. If the `project_exclusion_enabled` field is `true`, respondents who complete any other target group in the same project (that also has this setting enabled) will be excluded from this one.

📄️ Lists exclusion groups for an account

Lists the exclusion groups for your account, ordered by creation date. Use exclusion groups to prevent respondents from participating in multiple target groups, even across different projects.

📄️ Lists target groups in an exclusion group

Lists the target groups that belong to a specific exclusion group. Respondents who complete one target group in this list will be excluded from participating in any of the others. **An exclusion group can contain a maximum of 100 target groups.**

📄️ Update Target Group Project Exclusion Status

Updates the project-level exclusion status for multiple target groups in a single request. When you enable project exclusion for a target group, respondents who complete it will be prevented from entering any other target group within the same project that also has this setting enabled.

📄️ Retrieves exclusion group by ID

Retrieves the details of a specific exclusion group, including its tag, description, and creation date.

📄️ Retrieve RID upload job status

Gets the status of a job within the target group to update respondent ID based exclusions, of any type of ID. You should be checking this endpoint regularly to see the status of your work. While execution time may vary, adding 10,000 respondents typically takes between 3 and 5 minutes.

📄️ Retrieves the number of currently excluded response IDs (RSID) on a target group.

Retrieves the number of currently excluded response IDs (RSID) on a target group - both response ID and GUID. This is useful to understand how close you are to any limits or the effect of deduplication or other asynchronous operations.

📄️ Remove Target Groups from an Exclusion Group

Removes one or more target groups from an exclusion group. **Important behavior:** Removing a target group from this list only affects the exclusion status for **future** respondents; it does not apply retroactively.

📄️ Lists excluded Access Respondent GUIDs for a target group

Lists the Access Respondent GUIDs of all respondents who are excluded from this target group. This exclusion can be due to their participation in another target group within the same project or within a shared exclusion group.

📄️ 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 while performing 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.

📄️ Lists the exclusion groups of a specific target group

Lists all exclusion groups that a specific target group is a member of, ordered by creation date. When a respondent attempts to enter this target group, they will be checked against all other target groups in all of the exclusion groups listed here.

📄️ Creates a job to upload a file of respondent exclusions

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.

📄️ Lists project exclusion statuses for target groups

Lists the project-level exclusion status for all target groups within a project. This allows you to see which target groups will exclude respondents from one another at the project level.

📄️ Lists excluded Respondent IDs (RSIDs) for a target group

Lists the Respondent IDs (RSIDs) of all respondents who are excluded from this target group. This exclusion can be due to their participation in another target group within the same project, a shared exclusion group, or a direct file upload.

📄️ Add Target Groups to an Exclusion Group

Adds one or more target groups to an exclusion group. Target groups can be from any project within your account. **Key behaviors** * An exclusion group can contain a maximum of 100 target groups. * Adding a target group to this list only affects the exclusion status for **future** respondents; it does not apply retroactively.

📄️ Creates an exclusion group

Creates a new exclusion group for your account and returns its unique ID.

📄️ Updates exclusion group by ID

Updates the tag or description for a specific exclusion group.