COcommonroom
Contacts

Update many contacts

Apply the same change to up to 100 contacts in one request. The request must include at least one of segmentId, tagIdsToAdd, tagIdsToRemove, or customFields. Every ID, the segment, the tags, and the custom fields are validated before anything is written, and an error names every offending ID. Each change is idempotent: contacts already in the segment are skipped, so a request that fails part-way can be retried as a whole. Requires the contacts:write scope.

post/contacts/bulk

Request

Request body

contactIdsstring[] required

Prefixed contact IDs (format c_<number>). Duplicates are ignored.

segmentIdstring

Add every contact to this segment (format s_<number>).

tagIdsToAddstring[]

Tag IDs (format l_<number>) to add to every record.

tagIdsToRemovestring[]

Tag IDs (format l_<number>) to remove from every record.

Response

The contacts were updated

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.