Add people to a list

Adds people to the list. Send existing contacts' ids in contactIds, email addresses in emails, or both. An email that isn't a contact yet becomes a new contact — so sending emails also needs contacts:write. People already in the list are counted in alreadyIn and left as they are.

Path parametersCopy Anchor Link

BodyCopy Anchor Link

Send contactIds, emails, or both.

Example requestCopy Anchor Link

curl -X POST "https://api.pedibee.com/api/v1/lists/66f1c2a9e4b0a1b2c3d4e101/contacts" \
  -H "Authorization: Bearer $PEDIBEE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contactIds": [
      "66f1c2a9e4b0a1b2c3d4e5f6"
    ],
    "emails": [
      "sam@globex.com",
      "not-an-email"
    ]
  }'

ResponseCopy Anchor Link

What happened. Invalid addresses are reported, not added; the rest still go in.

{
  "added": 2,
  "alreadyIn": 0,
  "createdContacts": 1,
  "invalid": [
    "not-an-email"
  ]
}

ErrorsCopy Anchor Link

Every error is { "error": "…" } with a message you can show. See Errors and limits.