TextKitDocs

Tag, untag, or delete many contacts

One action for up to 500 contact ids.

POST/v1/contacts/bulk

Body Parameters

  • actionadd_tags, remove_tags, deleterequired
  • idsarray of stringrequired

    At most 500 items.

  • tagsarray of string

    Required for add_tags and remove_tags

Details

Ids that do not exist are counted in missing; the rest are applied.

Responses

  • 200JSON object

    Result

  • 400Error

    Invalid request

  • 401Error

    Missing, malformed, or revoked API key

  • 402Error

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 429Error

    Rate limit or quota exceeded

Response Fields

  • objectcontact_bulk
  • actionstring
  • updatedinteger
  • deletedinteger
  • missinginteger

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

  • 400

    Invalid request

  • 401

    Missing, malformed, or revoked API key

  • 402

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 429

    Rate limit or quota exceeded