List Channel reminders

GET 
/v3/reminders

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

Request

Query Parameters

survey_id numberrequired

Id of the survey

channel_id numberrequired

Id of the channel

limit number

Possible values: >= 1 and <= 100

Default value: 50

page number

Possible values: >= 1

Responses

200

Successful

*/*

Schema

Schema

has_next_page boolean

More items in the collection?

data

object[]

Array [

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)

{
  "has_next_page": true,
  "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...