Skip to content

Document bulk companies API (Preview) - #603

Merged
VarshSuresh merged 1 commit into
mainfrom
varsh.suresh/document-bulk-companies-api
Jul 29, 2026
Merged

Document bulk companies API (Preview)#603
VarshSuresh merged 1 commit into
mainfrom
varsh.suresh/document-bulk-companies-api

Conversation

@VarshSuresh

@VarshSuresh VarshSuresh commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

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 the company_id you define (parity with the single create-or-update company endpoint).
  • PUT /companies/bulk — bulk update by company id; unknown ids fail per-item and never create.
  • POST /companies/bulk/delete — bulk delete by company id; 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_job response schema. Each request is an async job (max 100 items); a failed item ends the job as completed_with_errors without failing the batch.

Generated with Claude Code


Update: added 403 / forbidden

A third undocumented error response, confirmed against a live response body: appending to a job that has already closed returns 403 with code forbidden and message job <job_id> is closed for new task updates.

Added to all three bulk companies write endpoints, ordered before 404. Each now documents 202, 401, 403, 404, 422 — matching the bulk contacts endpoints.

The example uses the job_v2_1 placeholder that the other job examples in this spec already use, rather than a real job id.

@VarshSuresh
VarshSuresh force-pushed the varsh.suresh/document-bulk-companies-api branch 5 times, most recently from 4d81cf4 to 1a94629 Compare July 29, 2026 13:12
@VarshSuresh
VarshSuresh requested a review from a team July 29, 2026 13:22
@VarshSuresh
VarshSuresh marked this pull request as ready for review July 29, 2026 13:22
@VarshSuresh
VarshSuresh force-pushed the varsh.suresh/document-bulk-companies-api branch from 1a94629 to e1b239d Compare July 29, 2026 13:24
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@VarshSuresh
VarshSuresh force-pushed the varsh.suresh/document-bulk-companies-api branch from e1b239d to 4ab7513 Compare July 29, 2026 13:32
@VarshSuresh
VarshSuresh merged commit bf28255 into main Jul 29, 2026
3 checks passed
@VarshSuresh
VarshSuresh deleted the varsh.suresh/document-bulk-companies-api branch July 29, 2026 13:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants