Update a subscription list

Update subscription list

curl --request PATCH \
  --url https://api.paubox.com/v1/marketing/subscription_lists/{subscription_list_id} \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '
{
  "name": "Updated Newsletter Subscribers"
}
'

import requests

url = "https://api.paubox.com/v1/marketing/subscription_lists/{subscription_list_id}"

payload = { "name": "Updated Newsletter Subscribers" }
headers = {
    "authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Updated Newsletter Subscribers'})
};

fetch('https://api.paubox.com/v1/marketing/subscription_lists/{subscription_list_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.paubox.com/v1/marketing/subscription_lists/{subscription_list_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Updated Newsletter Subscribers'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.paubox.com/v1/marketing/subscription_lists/{subscription_list_id}"

	payload := strings.NewReader("{\n  \"name\": \"Updated Newsletter Subscribers\"\n}")

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

	req.Header.Add("authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.paubox.com/v1/marketing/subscription_lists/{subscription_list_id}")
  .header("authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Updated Newsletter Subscribers\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paubox.com/v1/marketing/subscription_lists/{subscription_list_id}")

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

request = Net::HTTP::Patch.new(url)
request["authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Updated Newsletter Subscribers\"\n}"

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

{
  "data": {
    "id": "<string>",
    "type": "subscription_list",
    "attributes": {
      "name": "<string>",
      "is_default": true,
      "subscriber_count": 123,
      "form_id": "<string>"
    }
  }
}

{
  "error": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "code": "<string>",
  "details": {}
}

PATCH

subscription_lists

{subscription_list_id}

Update subscription list

curl --request PATCH \
  --url https://api.paubox.com/v1/marketing/subscription_lists/{subscription_list_id} \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '
{
  "name": "Updated Newsletter Subscribers"
}
'

import requests

url = "https://api.paubox.com/v1/marketing/subscription_lists/{subscription_list_id}"

payload = { "name": "Updated Newsletter Subscribers" }
headers = {
    "authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Updated Newsletter Subscribers'})
};

fetch('https://api.paubox.com/v1/marketing/subscription_lists/{subscription_list_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.paubox.com/v1/marketing/subscription_lists/{subscription_list_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Updated Newsletter Subscribers'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.paubox.com/v1/marketing/subscription_lists/{subscription_list_id}"

	payload := strings.NewReader("{\n  \"name\": \"Updated Newsletter Subscribers\"\n}")

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

	req.Header.Add("authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.paubox.com/v1/marketing/subscription_lists/{subscription_list_id}")
  .header("authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Updated Newsletter Subscribers\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paubox.com/v1/marketing/subscription_lists/{subscription_list_id}")

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

request = Net::HTTP::Patch.new(url)
request["authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Updated Newsletter Subscribers\"\n}"

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

{
  "data": {
    "id": "<string>",
    "type": "subscription_list",
    "attributes": {
      "name": "<string>",
      "is_default": true,
      "subscriber_count": 123,
      "form_id": "<string>"
    }
  }
}

{
  "error": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "code": "<string>",
  "details": {}
}

Authorizations

authorization

string

header

required

Token-based authentication. Use format: "Token token=<API_KEY>" where <API_KEY> is your API key

Path Parameters

subscription_list_id

string

required

The ID of the subscription list to update

Body

application/json

name

string

required

Name of the subscription list

Response

Subscription list updated successfully

data

object

Show child attributes

⌘I

Email API · Messages

Email API · Dynamic templates

Marketing · Campaigns

Marketing · Drip campaigns

Marketing · Subscribers

Marketing · Subscription lists

Marketing · Tracking links

Marketing · Analytics

Forms API

Authorizations

Path Parameters

Body

Response