We hope you enjoy our updated documentation! The old documentation website is still available here. Reach out to us with feedback or questions. Happy programming! 🎉

Add a PSIDref list to a survey

POST

/surveys/{SURVEY_ID}/PSIDref

Last modified:2025-07-20 15:11:45

Description

Use this endpoint to add a PSIDref list to a survey in order to allow or not allow respondents from previous studies, to access the current survey ID.

More information about recontact /exclusion an be found in the PSID Exclusion / Recontact guide.

Request

Path Params

Header Params

Body Params application/json

Example

[
    { "psid": "75xxee23-370b-a8ye-e601-e1fzz59284c8" },
    { "psid": "94xx7b3b-4608-01y4-b908-8aezzab971e1" },
    { "psid": "24xx7db6-8507-47y9-9c67-0c6zz6244d98" },
    { "psid": "599446a6-6388-4ffe-4c37-9bdc9f6e6edc" },
    { "psid": "685330d0-a8f2-df6f-ae28-7eb89d290277" }
]

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://staging.spectrumsurveys.com/buyers/v2/surveys/{{SURVEY_ID}}/PSIDref' \
--header 'access-token: ' \
--header 'Content-Type: application/json' \
--data-raw '[
    { "psid": "75xxee23-370b-a8ye-e601-e1fzz59284c8" },
    { "psid": "94xx7b3b-4608-01y4-b908-8aezzab971e1" },
    { "psid": "24xx7db6-8507-47y9-9c67-0c6zz6244d98" },
    { "psid": "599446a6-6388-4ffe-4c37-9bdc9f6e6edc" },
    { "psid": "685330d0-a8f2-df6f-ae28-7eb89d290277" }
]'

Responses

🟢201Created

application/json

Body

Example

[
    {
        "psid": "75xxee23-370b-a8ye-e601-e1fzz59284c8",
        "link": null
    },
    {
        "psid": "24xx7db6-8507-47y9-9c67-0c6zz6244d98",
        "link": null
    },
    {
        "psid": "685330d0-a8f2-df6f-ae28-7eb89d290277",
        "link": null
    },
    {
        "psid": "94xx7b3b-4608-01y4-b908-8aezzab971e1",
        "link": null
    },
    {
        "psid": "599446a6-6388-4ffe-4c37-9bdc9f6e6edc",
        "link": null
    }
]

🟠400Bad Request

Modified at 2025-07-20 15:11:45

Respondent inclusion / exclusion

Update a PSIDref for survey

Add a PSIDref list to a survey

Description#

Request

Request Code Samples

Responses

Description