search
Drop Cowboy

Append Contacts To List

This endpoint allows you to add contacts to a specific list identified by list_id.

hashtag
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 addContactstToList(listId) {
      const list = await client.appendContactsToList(listId, {
            fields: ["first_name", "email", "phone"],
            values: [
                ["hunter", "hunter@email.com", "+15552223333"],
                ["john", "john@email.com", "+15554446666"]
            ]
      });

      console.log(list);
};

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

hashtag
API Endpoint

POST

hashtag
Example Request

hashtag
Required Headers

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

  • x-secret - Your Secret Key from API settings

hashtag
Required URL Path Parameters

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

hashtag
Required Body Parameters

  • fields (array of strings): An array specifying the fields that will be populated for each contact (e.g., ["record_id"]). This parameter is required.

  • values (array of arrays): An array of arrays. Inner arrays contain the values associated with the field types you specify in the fields attribute. You may pass in up to 10,000 contacts per API call. This parameter is required.

hashtag
Optional Body Parameters

  • region (string): Array of strings that define the data types being passed in the values attribute. It is acceptable to have repeat field types specified if your contacts have multiple phone numbers, pass in the value of "phone" multiple times in this array. Possible field types are: record_id, first_name, last_name, company, email, phone, address1, address2, city, state, postal, country, custom1, custom2, custom3, custom4, custom5.

hashtag
Append contacts to a 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
fieldsstring[]Required

Array of strings that define the data types being passed in the Values attribute. It is acceptable to have repeat field types specified if your contacts have multiple phone numbers, pass in the value of “phone” multiple times in this array. Possible field types are: record_id, first_name, last_name, company, email, phone, address1, address2, city, state, postal, country, custom1, custom2, custom3, custom4, custom5. (Required)

regionstringOptional

The ISO country code to use when converting your phone number values to E.164 format. If yourphone numbers are already formatted in E.164 then the region attribute is ignored. Defaults to US.

Responses
chevron-right
200

Returns accepted_count and rejected details.

application/json
accepted_countintegerOptional

The number of contacts appended to the list.

post
/list/{list_id}/contacts
200

Returns accepted_count and rejected details.

hashtag
Example Response

The response will be in JSON format and will include the following fields:

  • accepted_count (integer): The number of contacts appended to the list.

  • rejected (array): An array of objects containing the index of the rejected contact from the value array that you passed to the api and the reason that contact was rejected, where each object contains:

    1. index (integer): The index of the rejected contact in the original request.

    2. reason (string): The reason for rejection (if applicable).

PreviousRename Contact ListNextGet Contact List Details

Last updated

Was this helpful?