docs(preview): add bulk contacts endpoint and merged contact 410 response#469
Open
docs(preview): add bulk contacts endpoint and merged contact 410 response#469
Conversation
…onse
Documents two new Preview API features:
1. POST /contacts/bulk and GET /contacts/bulk/{id} — new bulk update endpoint
with clean request format, async job tracking, and status polling (PR #495002)
2. 410 Gone with Link header for merged contacts on GET /contacts/{id} and
GET /contacts/find_by_external_id/{external_id} — returns RFC 8288 Link
header pointing to canonical contact (PR #497262)
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
aa2df81 to
c529724
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
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?
Two new Preview API features were shipped in the monolith but not yet documented in the OpenAPI spec:
POST /contacts/bulkendpoint with a clean request format for bulk-updating contactsLinkheader for merged contacts instead of a generic 404How?
Added the new endpoint paths, request/response schemas, and 410 response documentation to the Preview spec (
descriptions/0/). The bulk endpoint includes async job tracking via a newcontacts_bulk_jobschema, and the merged contact response documents the RFC 8288Linkheader that points to the canonical contact.Generated with Claude Code