Update a List

Update the details of an existing subscriber list using its unique list UID. This includes modifying sender info, list settings, and optional default, notification data.

✏️ Update a List

Update an existing subscriber list using its unique ID.

🔹 HTTP Request

PUT API-URL/lists/LIST-UNIQUE-ID

🔸 URL Segments

Segment	Required	Description
LIST-UNIQUE-ID	Yes	Unique identifier of the list to update.

🔐 Authorization Header

Include your customer API key:

X-API-KEY: your-api-key-here

📝 PUT Parameters

Parameter	Type	Required	Description
data	array	Yes	Array containing list details. Accepts general, defaults, and notifications blocks.

---

📦 general Block (Required)

Parameter	Type	Required	Description
name	string	Yes	Name of the list.
description	string	No	List description

---

📦 defaults Block (Optional)

Parameter	Type	Required	Description
from_name	string	Yes	Sender's name.
from_email	string	Yes	Sender's email address.
reply_to	string	Yes	Reply-to email address.
subject	string	No	Default subject line.

---

📦 notifications Block (Optional)

Parameter	Type	Required	Description
subscribe	Yes/No	No	Notify on new subscriber (yes or no).
unsubscribe	Yes/No	No	Notify on unsubscribe (yes or no).
subscribe_to	string	No	Email address to receive subscribe notifications.
unsubscribe_to	string	No	Email address to receive unsubscribe notifications.

---

💻 PHP Example

// update list
$response = $endpoint->update('LIST-UNIQUE-ID', [
    // required
    'general' => [
        'name'          => 'API Test List - Updated!', // required
        'description'   => 'This is a test list, updated from the API.', // optional
    ],
    // optional
    'defaults' => [
        'from_name' => 'Emily Carter', // required
        'from_email'=> '[email protected]', // required
        'reply_to'  => '[email protected]', // required
        'subject'   => 'Welcome to Our Newsletter!', // required
    ],
    // optional
    'notifications' => [
        // notification when new subscriber added
        'subscribe'         => 'yes', // yes|no
        // notification when subscriber unsubscribes
        'unsubscribe'       => 'yes', // yes|no
        // where to send the notifications.
        'subscribe_to'      => '[email protected]',
        'unsubscribe_to'    => '[email protected]',
    ],
]);

// and get the response
echo '<pre>';
print_r($response->body);
echo '</pre>';

📦 Sample JSON Response

{
  "status": "success"
}