Skip to content

Latest commit

 

History

History
131 lines (131 loc) · 3.57 KB

Modify a list.md

File metadata and controls

131 lines (131 loc) · 3.57 KB

Modify a list

Updates a sending list.

Remember to provide the authentication HTTP headers as described in the Authenticate using a session key and the Authenticate using a user token sections.
All the query string parameters in URL must be UTF-8 URL Encoded.

HTTP Headers

user_key / Session_key

HTTP Method

PUT

HTTP Request

https://app.gateway.smsend.it/API/v1.0/REST/list/{list_id}

Parameters

Parameter Type Description Required Default
list_id Int The ID of the list to modify Yes -

Body Fields

Parameter Type Description Required Default
title String The list name No -
id_language String (e.g. “ita”) The list default language No -
email_sender a valid email The sender’s email address No -
reply_to a valid email The email to be used for the ‘reply_to’ email field No -
company_name String The company name No -
company_address String The company address No -
company_url String The company website URL No -
company_phone String The company phone number No -
company_fax String The company FAX number No -
status Int The list status (0 = Active, 1 = Archived, 2 = To Be Activated) No -

Returns

Code Description
204 List updated, The HTTP location header that points to the created list
400 Other errors, details are in the body
401 [Unauthorized] User_key, Token or Session_key are invalid or not provided
404 [Not found] The User_key was not found