docs(preview): document updatable fields and tag add/remove on POST /contacts/bulk#538
Open
kstenson wants to merge 1 commit into
Open
docs(preview): document updatable fields and tag add/remove on POST /contacts/bulk#538kstenson wants to merge 1 commit into
kstenson wants to merge 1 commit into
Conversation
…contacts/bulk
- Documents the full set of updatable fields the endpoint accepts
(user_id, phone, owner_id, unsubscribed_from_emails, avatar,
custom_attributes, companies, company) and notes that other fields
are ignored.
- Adds a `tags` object (add/remove arrays of `{ id }`) to each contact.
- Adds a tag request example and the missing-`id` 422 example.
Tag application is best-effort and asynchronous: unknown tag IDs are
skipped and per-tag results are not yet returned in the job status, so
no synchronous tag-error response is documented.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
e98d502 to
e41f01a
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why?
The Preview spec documented the original
POST /contacts/bulkendpoint but predated inline tag management, and its request schema listed only a subset of the fields the endpoint actually accepts. This brings the docs up to date with the endpoint's current behaviour.How?
user_id,phone,owner_id,unsubscribed_from_emails,avatar,custom_attributes,companies,company) and notes that any other fields in a contact object are ignored.tagsobject (add/removearrays of{ id }) to each contact so tags can be added or removed inline.id422 example.Tag application is best-effort and asynchronous: unknown tag IDs are skipped and per-tag results are not returned in the job status, so no synchronous tag-error response is documented.
Companions
Generated with Claude Code