Update a List
Legacy Marketing Campaigns
You are viewing the Legacy Marketing Campaigns API reference. For guidance migrating to the current version of Marketing Campaigns, see Migrating from Legacy Marketing Campaigns
Info
For the most up-to-date information on SendGrid's Contact Lists API, please visit the new Marketing Campaigns Lists API.
The Lists API allows you to manage your Marketing Campaigns contact lists. You can create, retrieve, update, and delete lists, as well as add and remove contacts from lists.
PATCH/v3/contactdb/lists/{list_id}
Base url: https://api.sendgrid.com (The Twilio SendGrid v3 API)
This endpoint allows you to update the name of one of your recipient lists.
Bearer <<YOUR_API_KEY_HERE>>Optional
The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
application/jsonThe new name for your list.
Optional
The ID of the list
Optional
The new name for the list
Optional
The number of recipients on the list
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const list_id = 42;5const data = {6name: "newlistname",7};89const request = {10url: `/v3/contactdb/lists/${list_id}`,11method: "PATCH",12body: data,13};1415client16.request(request)17.then(([response, body]) => {18console.log(response.statusCode);19console.log(response.body);20})21.catch((error) => {22console.error(error);23});
