Update a channel

PUT 
/v3/channels/:id

Supported only for LINK, SMS, EMAIL and OFFLINE 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

Path Parameters

id numberrequired

Id of the channel

application/json

Body

survey_id numberrequired

Id of the survey

Responses

200

Successful

*/*

Schema

Schema

data

object

id number

Id of channel

name string

Name of channel

status string

Status of the share

type string

Type of channel

properties object

Example (from schema)

{
  "data": {
    "id": 1,
    "name": "Email share 1",
    "status": "ACTIVE",
    "type": "EMAIL",
    "properties": {}
  }
}

Loading...