COcommonroom
Objects

Update many custom objects

Apply the same change to up to 100 custom objects 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. A tag must be scoped to the object type of every listed object. Each change is idempotent: custom objects already in the segment are skipped, so a request that fails part-way can be retried as a whole. Requires the objects:write scope.

post/objects/bulk

Request

Request body

objectIdsstring[] required

Prefixed custom object IDs (format co_<number>). Duplicates are ignored.

segmentIdstring

Add every custom object 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 custom objects were updated

successtrue required

Changes

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