Rename Contact List

This endpoint allows you to update the name of a specific list identified by list_id.


Using the SDK

// Download the helper library from https://www.npmjs.com/package/dropcowboy
const { DropCowboy } = require("dropcowboy"); // Or, for ESM: import { DropCowboy } from "dropcowboy";

// Find your Team ID and Secret at dropcowboy.com/appv1/#/api
// and set the environment variables.
const teamId = process.env.DROPCOWBOY_TEAM_ID;
const secret = process.env.DROPCOWBOY_SECRET;
const client = new DropCowboy({ teamId: teamId, secret: secret });

async function renameList(listId) {
      const list = await client.renameContactList(listId, { list_name: "My Contacts - Renamed" });

      console.log(list);
};

renameList("00000000-0000-0000-0000-000000000000");

API Endpoint

POST


Example Request

Required Headers

  • x-team-id - Your Team ID from API settings

  • x-secret - Your Secret Key from API settings

Required URL Path Parameters

  • list_id (string) - The id of the list to be renamed. This parameter is required.

Required Body Parameters

  • list_name (string) - The new name for the list. This parameter is required.

Rename contact list

post
Authorizations
x-team-id / x-secretstringRequired

Requires two headers: x-team-id and x-secret. Both must be sent with each request.

Path parameters
list_idstringRequired
Body
list_namestringRequired
Responses
chevron-right
200

200 OK on success

No content

post
/list/{list_id}
200

200 OK on success

No content


Example Response

The response will have a 200 OK status code on successful updates.

Last updated

Was this helpful?