Create Welcome Series

Creates a new Welcome Series, prepopulated with two messages.

Resource URL:

POST https://api.essential.to/v2/channel/{sid}/welcome_series/create_default

Resource information:

Response format	JSON
Requires authentication?	Yes

Parameters:

name required	Name for the Welcome Series.
position optional	Querystring parameter indicating the position in the list at which the new series should be placed. Position and tags are used to determine which series to send to a subscriber: the series with the highest position (largest number) with a tag that matches the tag subscribers are being added to will be selected. Position 0 is reserved for the default welcome series, which will be sent when no other series is selected.

name

required

Name for the Welcome Series.

position

optional

Querystring parameter indicating the position in the list at which the new series should be placed. Position and tags are used to determine which series to send to a subscriber: the series with the highest position (largest number) with a tag that matches the tag subscribers are being added to will be selected. Position 0 is reserved for the default welcome series, which will be sent when no other series is selected.

Sample code:


curl -X POST \
     -u '[SID]:[TOKEN]' \
     -H 'Content-Type: application/json' \
     'https://api.essential.to/v2/channel/3mesNha3El_vwtUUC-iW8Q/welcome_series/create_default?position=1' \
     -d '{"name":"New Sample Welcome Series"}'

# Sample response
{
  "sequence": 1,
  "created_at": "2017-08-15T22:20:06.597Z",
  "updated_at": "2017-08-15T22:20:06.597Z",
  "sid": "P-AcW9CmQUmXmxnIvAdPhQ",
  "channel_sid": "3mesNha3El_vwtUUC-iW8R",
  "tag_sids": [

  ],
  "name": "New Sample Welcome Series",
  "status": "disabled",
  "item_sids": [
    "9WLZrixqAH5vpDIe6okn-Q",
    "6dqd64mW0gEsLSn0vbUdcg"
  ]
}
Python coming soon.
Node coming soon.