Create Reminder for a channel

POST 
/v3/reminders

Only applicable for Classic, CX and Chat surveys via EMAIL, SMS channels

Request

application/json

Body

channel_id numberrequired

Id of the channel

survey_id numberrequired

Id of Survey

body string
subject string
frequency stringrequired

Possible values: [Days, Weeks, Months]

type stringrequired

Possible values: [NOT_RESPONDED, PARTIALLY_RESPONDED]

interval numberrequired

properties

object

Properties of the reminder

embed_first_question booleanrequired

custom_footer booleanrequired

custom_footer_value string

Responses

200

Successful

*/*

Schema

Schema

data

object

id numberrequired

Id of reminder

subject stringrequired

Subject of reminder

frequency stringrequired

Possible values: [Days, Weeks, Months]

Frequency of reminder

type stringrequired

Possible values: [NOT_RESPONDED, PARTIALLY_RESPONDED]

Type of reminder

after_days numberrequired

sent_count numberrequired

Default value: 0

created_at daterequired

updated_at daterequired

survey_id numberrequired

Id of Survey

account_id numberrequired

Id of Account

message string

Return a message when Partial Respondents reminder type is created without turning on partial submissions in the survey settings

Example (from schema)

{
  "data": {
    "id": 1,
    "subject": "Your feedback matters!",
    "frequency": "Days",
    "type": "NOT_RESPONDED",
    "after_days": 0,
    "sent_count": 0,
    "created_at": "2024-09-26",
    "updated_at": "2024-09-26",
    "survey_id": 1,
    "account_id": 1,
    "message": "string"
  }
}

Loading...