Register Intent V2
Register Intent - POST /surveys/register/:survey_id - https://api.spectrumsurveys.com/suppliers/v2/surveys/register/:surveyId?intent_count=%intent_count%Suppliers should use the POST method to register intent to send sample. Once intent is registered, this method will return an entry link in the API response. As an additional parameter, you may specify a partial intent to fill the survey.
Please note, that while this parameter is not 'REQUIRED' many of the Buyers use it as an indicator of of interest and activity in the current and future projects. It is an important opportunity to communicate with the Buyer your desire to participate in their projects.
If the surveys has hit your performance guardrails, and you will no longer send sample to the survey, it is imperative that you call the register intent api with in intent_count=0
HEADER
Parameter | Type | Required | Description |
|---|---|---|---|
access-token | String | Yes | Token used to identify the authenticity of the user. |
QUERY STRING REQUEST PARAMETERS
Parameter | Type | Required | Description |
|---|---|---|---|
intent_count | integer | No | This field tells Purespectrum, and the Buyer, how much of your allocation you intend to fulfill. |
RESPONSE PARAMETERS
Parameter | Type | Description |
|---|---|---|
survey_entry_url | String | Entry URL for the survey |
Sample Request
POST /suppliers/v2/surveys/register/2551?intent_count=0 HTTP/1.1
Host: staging.spectrumsurveys.com:3000
access-token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxSample Response
{
"apiStatus": "success",
"version": "2.0",
"msg": "Supplier successfully added to Survey",
"survey_entry_url": "http://staging.spectrumsurveys.com:3000/startsurvey?survey_id=2551&supplier_id=7"
}
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________
NEW!
Delete Register Intent - DELETE /suppliers/v2/surveys/:survey_id/intentOnce intent is registered, you may use the DELETE method to remove the registered intent for the specified survey. This is materially different from passing in “intent_count=0” as it is actually deleting your registered intent completely. This alleviates the need to check Paused surveys because the registered_intent=false, so in your GET Surveys API call, you may re-register intent for this opportunity again. So we recommend using this method when survey statuses are set to Paused.
HEADER
Parameter | Type | Required | Description |
|---|---|---|---|
access-token | String | Yes | Token used to identify the authenticity of the user. |
Sample Request
DELETE /suppliers/v2/surveys/:survey_id/intent
Host: staging.spectrumsurveys.com:3000
access-token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxSample Response
{
"apiStatus": "success",
"msg": "Register Intent has been successfully updated."
}