Update a survey scheduled start date

Overview

This endpoint updates the scheduled start date for a specific survey.

Authentication

This request requires an Authorization header with a valid token.

URL: POST https://api3.blocksurvey.io/v1/survey/scheduled_start_date

Body Parameters

Parameter	Type	Optional	Description
surveyId	String	No	The ID of the survey.
scheduledStartDateFlag	Boolean	No	Flag to set the scheduled start date (true/false).
scheduledStartDate	Number	No	The scheduled start date in timestamp format.
teamId	String	Yes	The team ID.

Here's the JSON body data:

{
    "surveyId": "123456",
    "teamId": "1234",
    "scheduledStartDateFlag": true,
    "scheduledStartDate": 1677619200000
}

cURL Example

curl --request POST \
 --url 'https://api3.blocksurvey.io/v1/survey/scheduled_start_date' \
 --header  'Authorization: Bearer user_api_token' \
 --header 'Content-Type: application/json' \
 --data '{
    "surveyId": "YOUR_SURVEY_ID",
    "scheduledStartDateFlag": true/false,
    "scheduledStartDate": TIMESTAMP,
    "teamId": "YOUR_TEAM_ID"
 }'

Remember to replace YOUR_SURVEY_ID, TIMESTAMP, and YOUR_TEAM_ID with actual values when testing or using this API endpoint. The scheduledStartDateFlag should be either true or false.

Response

Successful Response

{
  "status": "success",
  "message": "Survey scheduled start date updated successfully."
}