Skip to content
X-Buddy
Tiếng Việt

API reference

Add people to a lead list

lead_add_people — Add up to 200 people by @handle to a lead list.

Markdown version

lead_add_people · Changes an X-Buddy setting

Add up to 200 people by @handle to a lead list. People on the do-not-contact list are skipped and reported.
REST POST /api/public/v1/lead-lists/{list_id}/people
MCP tool lead_add_people
Permission needed leads.manage — Owner, Manager, Operator
Scope group audience:write
Group Contacts and lists
Shown up front in profiles Contacts & lists

Input

Field Type Required Description
list_id string (uuid) Yes Lead list id.
people array of string (1–60 chars) (1–200 items) Yes

Result

Returns the operation's result in the { data, meta } envelope.

Needs an idempotency key (Idempotency-Key, 8–128 characters). Retrying with the same key never repeats the action.

Example

Call over REST

curl -X POST "https://reach-link-craft.lovable.app/api/public/v1/lead-lists/00000000-0000-4000-8000-000000000001/people" \
  -H "Authorization: Bearer $XBUDDY_API_KEY" \
  -H "Idempotency-Key: 6f1c2a90-example-key" \
  -H "Content-Type: application/json" \
  -d '{"people":["@example_person"]}'

Call over MCP

{
  "method": "tools/call",
  "params": {
    "name": "lead_add_people",
    "arguments": {
      "list_id": "00000000-0000-4000-8000-000000000001",
      "people": [
        "@example_person"
      ],
      "idempotency_key": "6f1c2a90-example-key"
    }
  }
}

Errors you may get

Code HTTP Retryable
unauthorized 401 No
key_expired 401 No
integration_revoked 401 No
connection_not_linked 403 No
integration_paused 403 No
workspace_integrations_paused 403 No
integration_authorization_lost 403 No
workspace_suspended 403 No
forbidden 403 No
invalid_input 422 No
rate_limited 429 Yes
internal 500 Yes
read_only 403 No
idempotency_key_required 428 No
idempotency_conflict 409 No
idempotency_processing 409 Yes
conflict 409 No
precondition_failed 422 No
not_found 404 No

Back to all operations