Create exclusion group

POST

/surveygroups

Last modified:2025-10-05 18:04:11

Description

Use case: two surveys are related, and a respondent who participated in one survey cannot participate in the other survey.

The value you assign to buyer_surveygroup_ref must be globally unique within our system. Consider adding "-[YOUR COMPANY NAME]" to the end of your desired value to ensure this.

You can't group a survey that had been created with incl_excl=1 (a recontact survey).

The created exclusion group once added on another survey will automatically include in its list that survey as well.

Example: You create a survey group with survey A and survey B. And you create a new survey C using buyer_surveygroup_ref that has survey A and B. If you create another survey D using the same buyer_surveygroup_ref then survey C will be also included on the buyer_surveygroup_ref.

Request

Authorization

Add parameter in header

access-token

Example:

access-token: ********************

Body Params application/json

Example

{
    "buyer_surveygroup_ref": "ExclPr",
    "name": "Cosmetics Project",
    "surveys_in_group": [
        400689,
        400690
    ],
    "exclusion_period": 120
}

Request Code Samples

Shell

JavaScript

Java

PHP

Python

Ruby

curl --location 'https://staging.spectrumsurveys.com/buyers/v2/surveygroups' \
--header 'access-token: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "buyer_surveygroup_ref": "ExclPr",
    "name": "Cosmetics Project",
    "surveys_in_group": [
        400689,
        400690
    ],
    "exclusion_period": 120
}'

Responses

🟢201Created

application/json

Bodyapplication/json

Example

{
    "buyer_surveygroup_ref": "ExclPr",
    "name": "Cosmetics Project",
    "surveys_in_group": [
        400689,
        400690
    ],
    "exclusion_period": 120
}

🟠400Bad Request

🟠404Not Found

Modified at 2025-10-05 18:04:11

Survey group exclusions

Update exclusion group

Create exclusion group

Description#

Request

Request Code Samples

Responses

Description