---
title: "Create a channel"
method: POST
path: "/v3/channels"
tags: ["channels"]
---

# Create a channel

`POST /v3/channels`

schedule, relative_schedule only required when mode is RECURRING, RELATIVE_RECURRING respectively and sms, email, link properties only required when type is SMS, EMAIL, LINK and animation_direction can be provided when type is OFFLINE

## Request body

- Model82
  - `type` 'EMAIL' | 'SMS' | 'LINK' | 'OFFLINE', required — Type of the channel
  - `mode` 'BLAST' | 'RECURRING' | 'RELATIVE_RECURRING' — Mode of the channel, not required when type is LINK and OFFLINE
  - `channel_id` number — Deprecated, please use update channel instead
  - `contacts` Model74[]
    - `email` string — Email of contact. Can be optional only if anonymous contact feature is enabled.
    - `mobile` string — Mobile number in E.164 format, required when type is SMS
    - `referenceId` string — Reference ID of the anonymous contact
    - `variables` Properties
  - `contact_list_ids` number[]
  - `variables` Properties
  - `survey_id` number, required — Id of the survey
  - `name` string, required — Name of the channel
  - `send_after_date` string, date — Timestamp at which survey should be sent
  - `send_after_days` number — Number of days after which survey should be shared
  - `schedule` Schedule
    - `frequency` 'WEEKLY' | 'MONTHLY' | 'YEARLY', required
    - `config` Config, required
      - `h` number[], required
      - `m` number[], required
      - `d` string[], required
  - `relative_schedule` RelativeSchedule
    - `first_nps` FirstNps
      - `delay` number, required — Delay after which first survey to be shared
      - `unit` 'Days' | 'Months' | 'Hours', required — Unit of the delay
      - `contact_property_id` number, required — Id of the contact property, only DATE type contact properties are allowed
    - `after_first_nps_schedule` 'NONE' | 'EVERY_45_DAYS' | 'EVERY_3_MONTHS' | 'EVERY_6_MONTHS' | 'EVERY_1_YEAR', required — Repetition of survey sharing after first share
  - `reminders` Model79[] — Array of reminders
    - `subject` string — Subject of the reminder, both {company_name} and {survey_link} variables are required when channel type is SMS
    - `body` string — Body of the reminder. Not required for SMS channel type. Note:Placeholders are supported for Customer Experience (CX) surveys only.
    - `type` 'NOT_RESPONDED' | 'PARTIALLY_RESPONDED', required — Type of the responders
    - `interval` number, required — Delay after which reminder to be sent
    - `frequency` 'Days' | 'Weeks' | 'Months', required — Unit of the delay
    - `properties` Model78 — Properties of the reminder
      - `embed_first_question` boolean, required
      - `custom_footer` boolean, required
      - `custom_footer_value` string
      - `preview_text` string — Pre-header of the Email
  - `sms` Sms — Only required when type is SMS
    - `message` string — Message of sms, both {company_name} and {survey_link} variables are required.
    - `twilio_consent_agreed` boolean — For using SurveySparrow message service you need to agree the consent
    - `target_id` number — Id of the custom target, default target will be taken if not given
  - `email` Model81
    - `subject` string, required — Subject of the email
    - `properties` Model80
      - `body` string — Body of the email
      - `from_address` string — From address of the email
      - `embed_first_question` boolean, required
      - `custom_footer` boolean
      - `custom_footer_value` string — Custom footer value
      - `show_surveysparrow_branding` boolean, required — Set true to show SurveySparrow branding on email
      - `reply_to` string — Reply to address of the email
      - `preview_text` string — Pre-header of the Email
    - `theme_id` number — Id of the email theme
  - `link` Link
    - `title` string — Title of the weblink channel
    - `description` string — Description of the web link channel
    - `image_link` string — Image link of the weblink channel, provide link for a JPEG or PNG image. Get best results when the image is 1200 x 630 pixels
  - `offline` Offline
    - `animation_direction` 'Horizontal' | 'Vertical' — Animation Direction of the offline channel
  - `ignore_throttled_contacts` boolean — If set to true, survey will be shared even if throttling is met
  - `accept_anonymous_response` boolean — Only applicable for CX survey types

## Response `200`

Successful

---

[API](https://skmtc.net/surveysparrow/apis/api-documentation.md) · [All operations](https://skmtc.net/surveysparrow/apis/api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/surveysparrow/api-documentation/versions/f9da74f558da/schema)