Update survey

Description

This endpoint updates all attributes and properties of an existing survey with news ones that are passed in the request body.

This is an overwrite operation, which means any existing attributes or properties will not be merged with existing ones. All survey attributes and properties will be overriden with the ones in the new payload.

Request

Authorization

Add parameter in header

access-token

Example:

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

Path Params

Body Params application/json

Example

{
    "survey_title": "string",
    "survey_category_code": 0,
    "survey_localization": "string",
    "completes_required": 0,
    "offer_price": 0,
    "survey_pause_threshold": 0,
    "schedule_pause": {
        "enable": true,
        "info": [
            {
                "timezone": "string",
                "days": [
                    0
                ],
                "start_time": "14:15:22.123Z",
                "duration": {
                    "days": 1,
                    "hours": 8,
                    "minutes": 0
                }
            }
        ]
    },
    "incl_excl": 0,
    "quota_throttling": false,
    "click_balancing": 1,
    "expected_ir": 0,
    "expected_loi": 0,
    "live_url": "string",
    "test_url": "string",
    "feasibility_exclusions": {
        "enable": true,
        "start": "20250101",
        "end": "20251231",
        "criteriaSurveys": [
            0
        ],
        "statuses": [
            0
        ]
    },
    "subscriber_emails": [
        "string"
    ],
    "field_time": 0,
    "global_flexibility": 0,
    "buyer_message": "string",
    "billing_id": "string",
    "mc_unique_id": "string",
    "qualifications": [
        {
            "qualification_code": 0,
            "condition_codes": [
                "string"
            ],
            "range_sets": [
                {
                    "from": 0,
                    "to": 0,
                    "units": 0
                }
            ]
        }
    ],
    "qbp": {
        "enable": true
    },
    "qlc": {
        "enable": true,
        "multiple_quotas": {
            "enable": true,
            "count_by_quota": false,
            "compensate_by_quota": false
        }
    },
    "quotas": [
        {
            "buyer_quota_id": "string",
            "quota_title": "string",
            "required_count": 0,
            "criteria": [
                {
                    "qualification_code": 0,
                    "child_age_unit": 311,
                    "condition_codes": [
                        "string"
                    ],
                    "range_sets": [
                        {
                            "from": 0,
                            "to": 0,
                            "units": 0
                        }
                    ]
                }
            ],
            "group_key": "string"
        }
    ],
    "is_feot_enabled": true,
    "feot": {
        "pacing": "hours",
        "interval": 0,
        "is_custom": true
    },
    "is_dq_enable": true,
    "blend_id": "string",
    "buyer_surveygroup_ref": "string",
    "buyer_surveygroup_refs": [
        "string"
    ],
    "template_id": 0,
    "external_project_id": "string"
}

Request Code Samples

Shell

JavaScript

Java

PHP

Python

Ruby

curl --location --request PUT 'https://staging.spectrumsurveys.com/buyers/v2/surveys/' \
--header 'access-token: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "survey_title": "string",
    "survey_category_code": 0,
    "survey_localization": "string",
    "completes_required": 0,
    "offer_price": 0,
    "survey_pause_threshold": 0,
    "schedule_pause": {
        "enable": true,
        "info": [
            {
                "timezone": "string",
                "days": [
                    0
                ],
                "start_time": "14:15:22.123Z",
                "duration": {
                    "days": 1,
                    "hours": 8,
                    "minutes": 0
                }
            }
        ]
    },
    "incl_excl": 0,
    "quota_throttling": false,
    "click_balancing": 1,
    "expected_ir": 0,
    "expected_loi": 0,
    "live_url": "string",
    "test_url": "string",
    "feasibility_exclusions": {
        "enable": true,
        "start": "20250101",
        "end": "20251231",
        "criteriaSurveys": [
            0
        ],
        "statuses": [
            0
        ]
    },
    "subscriber_emails": [
        "string"
    ],
    "field_time": 0,
    "global_flexibility": 0,
    "buyer_message": "string",
    "billing_id": "string",
    "mc_unique_id": "string",
    "qualifications": [
        {
            "qualification_code": 0,
            "condition_codes": [
                "string"
            ],
            "range_sets": [
                {
                    "from": 0,
                    "to": 0,
                    "units": 0
                }
            ]
        }
    ],
    "qbp": {
        "enable": true
    },
    "qlc": {
        "enable": true,
        "multiple_quotas": {
            "enable": true,
            "count_by_quota": false,
            "compensate_by_quota": false
        }
    },
    "quotas": [
        {
            "buyer_quota_id": "string",
            "quota_title": "string",
            "required_count": 0,
            "criteria": [
                {
                    "qualification_code": 0,
                    "child_age_unit": 311,
                    "condition_codes": [
                        "string"
                    ],
                    "range_sets": [
                        {
                            "from": 0,
                            "to": 0,
                            "units": 0
                        }
                    ]
                }
            ],
            "group_key": "string"
        }
    ],
    "is_feot_enabled": true,
    "feot": {
        "pacing": "hours",
        "interval": 0,
        "is_custom": true
    },
    "is_dq_enable": true,
    "blend_id": "string",
    "buyer_surveygroup_ref": "string",
    "buyer_surveygroup_refs": [
        "string"
    ],
    "template_id": 0,
    "external_project_id": "string"
}'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "click_balancing": 0,
    "estimated_clicks": 0,
    "ps_survey_status": 11,
    "offer_price": 4.5,
    "incl_excl": 0,
    "live_url": "https://example.com/survey",
    "test_url": "https://example.com/survey-test",
    "survey_title": "Flo Test Survey",
    "survey_category_code": 231,
    "completes_required": 2000,
    "field_time": 10,
    "billing_id": "PS_123456",
    "buyer_message": null,
    "expected_loi": 60,
    "expected_ir": 60,
    "ps_survey_id": 1208502,
    "buyer_surveygroup_ref": null,
    "subscriber_emails": [],
    "survey_external_id": "",
    "qlc": {
        "enable": false,
        "multiple_quotas": {
            "enable": false,
            "count_by_quota": false,
            "compensate_by_quota": false
        }
    },
    "quota_throttling": false,
    "url_transform": false,
    "basic_token": {
        "enable": false,
        "value": null
    },
    "is_dq_enable": false,
    "blend_id": null,
    "supplier_allocation_throttle": true,
    "test_ps_survey_entry_link": "https://staging.spectrumsurveys.com/startsurvey?survey_id=1208502&ps_redirect_test=1&bsec=a70mx8&supplier_id=23",
    "survey_localization": "en_UK",
    "uniqueLinks": false,
    "qualifications": [
        {
            "condition_codes": [
                "111",
                "112"
            ],
            "qualification_code": 211
        },
        {
            "qualification_code": 212,
            "range_sets": [
                {
                    "from": 18,
                    "to": 55,
                    "units": 311
                }
            ]
        }
    ],
    "quotas": [
        {
            "buyer_quota_id": "QMales",
            "quota_title": "",
            "ps_quota_id": "2f00135f-193f-4b2d-9012-f49b87544c65",
            "required_count": 500,
            "criteria": [
                {
                    "qualification_code": 211,
                    "condition_codes": [
                        "111"
                    ]
                }
            ]
        },
        {
            "buyer_quota_id": "QFemales",
            "quota_title": "",
            "ps_quota_id": "c842edeb-9041-4c58-908e-002d6e43d26e",
            "required_count": 500,
            "criteria": [
                {
                    "qualification_code": 211,
                    "condition_codes": [
                        "112"
                    ]
                }
            ]
        },
        {
            "buyer_quota_id": "Q18to35",
            "quota_title": "",
            "ps_quota_id": "47c4ba91-8e56-41ca-afd4-a7dae37c6ce1",
            "required_count": 500,
            "criteria": [
                {
                    "qualification_code": 212,
                    "range_sets": [
                        {
                            "units": 311,
                            "to": 35,
                            "from": 18
                        }
                    ]
                }
            ]
        },
        {
            "buyer_quota_id": "Q36to55",
            "quota_title": "",
            "ps_quota_id": "9cf878d3-1ecf-40c0-9f07-b13b534ac889",
            "required_count": 500,
            "criteria": [
                {
                    "qualification_code": 212,
                    "range_sets": [
                        {
                            "units": 311,
                            "to": 55,
                            "from": 36
                        }
                    ]
                }
            ]
        }
    ],
    "mcqb": []
}

🟠400Bad Request

🟠401Unauthorized

Description#

Request

Request Code Samples

Responses

Description