Update List

PUT https://emailoctopus.com/api/1.6/lists/:listId

Update a list.

Parameters
api_key (string)	Your API key.
name (string)	The new name for the list.

200 (success) returns

Details of the updated list:

id (string) The identifier of the list.

name (string) The name of the list.

double_opt_in (boolean) If double opt-in has been enabled on the list.

fields (array)

tag (string)	The identifier used to reference the field in your emails.
type (string)	The type of the field - can be `NUMBER`, `TEXT` or `DATE`.
label (string)	A human readable label for the field.
fallback (string)	A default value for the field, used when there is no other value available.

counts (struct)

The summary counts of the list:

pending (integer)	The number of pending contacts in the list.
subscribed (integer)	The number of subscribed contacts in the list.
unsubscribed (integer)	The number of unsubscribed contacts in the list.

created_at (string) When the list was created, in ISO 8601 format.

Non-200 (error) returns

Details of the error:

code (string)	The error code.
message (string)	A description of the error.

Method-specific error codes
LIST_NOT_FOUND	The list could not be found.

API-wide error codes
INVALID_PARAMETERS	Parameters are missing or invalid.
API_KEY_INVALID	Your API key is invalid.
UNAUTHORISED	You're not authorised to perform that action.
NOT_FOUND	The requested endpoint does not exist.
UNKNOWN	An unknown error has occurred.

Example request
/api/1.6/lists/00000000-0000-0000-0000-000000000000?api_key=00000000-0000-0000-0000-000000000000&name=Foo

Example response
`{ "id": "00000000-0000-0000-0000-000000000000", "name": "Foo", "created_at": "2024-12-02T00:00:00+00:00" }`

Code sample copy
curl -X PUT \ https://emailoctopus.com/api/1.6/lists/00000000-0000-0000-0000-000000000000?api_key=00000000-0000-0000-0000-000000000000&name=Foo
$ch = curl_init(); curl_setopt($ch, CURLOPT_URL, 'https://emailoctopus.com/api/1.6/lists/00000000-0000-0000-0000-000000000000?api_key=00000000-0000-0000-0000-000000000000&name=Foo'); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT'); $result = curl_exec($ch); if (curl_errno($ch)) { echo 'Error:' . curl_error($ch); } curl_close($ch);
import requests params = ( ('api_key', '00000000-0000-0000-0000-000000000000'), ('name', 'Foo'), ) response = requests.put('https://emailoctopus.com/api/1.6/lists/00000000-0000-0000-0000-000000000000', params=params)
var https = require('https'); var options = { hostname: 'emailoctopus.com', port: 443, path: '/api/1.6/lists/00000000-0000-0000-0000-000000000000?api_key=00000000-0000-0000-0000-000000000000&name=Foo', method: 'PUT', }; var req = https.request(options); req.end();
package main import ( "io/ioutil" "log" "net/http" ) func main() { client := &http.Client{} req, err := http.NewRequest("PUT", "https://emailoctopus.com/api/1.6/lists/00000000-0000-0000-0000-000000000000?api_key=00000000-0000-0000-0000-000000000000&name=Foo", nil) if err != nil { log.Fatal(err) } resp, err := client.Do(req) if err != nil { log.Fatal(err) } bodyText, err := ioutil.ReadAll(resp.Body) if err != nil { log.Fatal(err) } }