Update a survey cut off date

Overview

This endpoint updates the cut-off date for a specific survey.

Authentication

This request requires an Authorization header with a valid token. URL: POST https://api3.blocksurvey.io/v1/survey/cut_off_date

Body Parameters

Parameter
Type
Optional
Description

surveyId

String

No

The ID of the survey.

cutOffDateFlag

Boolean

No

Flag to set the cut-off date (true/false).

cutOffDate

Number

No

The cut-off date in timestamp format.

teamId

String

Yes

The team ID.

Here's the JSON body data:

{
    "surveyId": "123456",
    "teamId": "1234",
    "cutOffDateFlag": true,
    "cutOffDate": 1677619200000
}

cURL Example

curl --request POST \
 --url 'https://api3.blocksurvey.io/v1/survey/cut_off_date' \
 --header  'Authorization: Bearer user_api_token' \
 --header 'Content-Type: application/json' \
 --data '{
    "surveyId": "YOUR_SURVEY_ID",
    "cutOffDateFlag": true/false,
    "cutOffDate": 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 cutOffDateFlag should be either true or false.

Response

Successful Response

{
  "status": "success",
  "message": "Survey cut off date updated successfully."
}

Last updated