EmailOctopus logo

API > Lists > Update list tag

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

Update list tag

Parameters
api_key (string) Your API key.
tag (string) A unique name for the tag.
200 (success) returns

Details of the new tag:

tag (string) The name of the tag.
Non-200 (error) returns

Details of the error:

code (string) The error code.
message (string) A description of the error.
Method-specific error codes
TAG_NOT_FOUND A tag with the supplied name could not be found for the given list.
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_key": "00000000-0000-0000-0000-000000000000",
    "tag": "vip"
}

                    
                
Example response
                    
                        {
    "tag": "vip"
}

                    
                
Code sample
copy
curl -X PUT -H "Content-Type: application/json" -d '{"api_key":"00000000-0000-0000-0000-000000000000","tag":"newTagName"}' https://emailoctopus.com/api/1.6/lists/00000000-0000-0000-0000-000000000000/tags/vip