Update a List

List_id is not reuseable

A deleted list_id can be restored via the Restore a List API and once deleted cannot be used to create a new list.

PUThttps://api.courier.com/lists/:list_id

Create or replace an existing list with the supplied values.

PATH PARAMS

list_idstringrequired

A unique identifier associated with the list you wish to retrieve.

BODY PARAM

namestringrequired

List name

preferencesobject

notificationsrecordrequired

json object that contains notification ids with the respective preferences

categoriesrecord

json object that contains category ids with the respective preferences

Responses

AUTH TOKEN

cURL

curl --request PUT \
     --url https://api.courier.com/lists/example.list.id \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '
{
  "name": "Example List Name"
}
'

Node.js

// Dependencies to install:
// $ npm install node-fetch --save

const fetch = require('node-fetch');

const options = {
  method: 'PUT',
  headers: {
    Accept: 'application/json',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "name": "Example List Name"
  })
};

fetch('https://api.courier.com/lists/example.list.id', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.courier.com/lists/example.list.id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Accept"] = 'application/json'
request["Content-Type"] = 'application/json'
request.body = "{\"name\":\"Example List Name\"}"

response = http.request(request)
puts response.read_body

Python

# Dependencies to install:
# $ python -m pip install requests

import requests

url = "https://api.courier.com/lists/example.list.id"

payload = {
  "name": "Example List Name"
}
headers = {
  "Accept": "application/json",
  "Content-Type": "application/json"
}

response = requests.request("PUT", url, json=payload, headers=headers)

print(response.text)

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.courier.com/lists/example.list.id"

  payload := strings.NewReader("{\"name\":\"Example List Name\"}")

  req, _ := http.NewRequest("PUT", url, payload)

  req.Header.Add("Accept", "application/json")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

PHP

<?php
// Dependencies to install:
// $ composer require guzzlehttp/guzzle

require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.courier.com/lists/example.list.id', [
  'body' => '{"name":"Example List Name"}',
  'headers' => [
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

Response Example

204 Successfully created400 Bad Request

Empty

Example

​ Method: PUT

URL: https://api.courier.com/lists/abcdefgh12345678

Body: ​

{
  "name": "Example List Name",
  "preferences": {
    "notifications": {
      "abcdefgh12345678": {
        "channel_preferences": [
          {
            "channel": "direct_message"
          }
        ],
        "rules": [
          {
            "type": "snooze"
          }
        ],
        "status": "OPTED_IN"
      }
    },
    "categories": {
      "cooking": {
        "channel_preferences": [
          {
            "channel": "direct_message"
          }
        ],
        "rules": [
          {
            "type": "snooze"
          }
        ],
        "status": "OPTED_IN"
      }
    }
  }
}