Document bulk companies API (Preview)#603
Draft
VarshSuresh wants to merge 1 commit into
Draft
Conversation
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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?
The bulk companies API is now available in Preview but has no OpenAPI coverage yet, so the endpoints aren't discoverable in the Preview reference docs.
How?
Documents four operations in the Preview spec, following the existing bulk contacts pattern:
POST /companies/bulk— bulk create or update, matched on thecompany_idyou define (parity with the single create-or-update company endpoint).PUT /companies/bulk— bulk update by companyid; unknown ids fail per-item and never create.POST /companies/bulk/delete— bulk delete by companyid; detaches associated contacts while keeping the company record.GET /companies/bulk/{id}— bulk job status.Adds the three bulk request schemas and a
companies_bulk_jobresponse schema. Each request is an async job (max 100 items); a failed item ends the job ascompleted_with_errorswithout failing the batch.Companion to:
Generated with Claude Code