From f1f1876e4fc6e30851304f9e91bfc2d0dd275135 Mon Sep 17 00:00:00 2001 From: leemour Date: Tue, 17 Nov 2026 03:09:32 +0100 Subject: [PATCH 01/18] feat(api): the api group from HubSpot's 15 CRM specs, version 2026-03 - spec/hubspot: contacts, companies, deals, tickets, leads, notes, calls, emails, meetings, tasks, owners, pipelines, properties, associations and account info, merged by mergeOpenApi. - The associations spec names three shared operations after 2025-09; a per-source patch gives them the object specs' ids so the merge takes the path once. - Names from the paths, 0-3 as deals; permission groups in cli-core's CRM words (people, organizations, deals, leads, users, fields). - batch/archive, labels/archive, gdpr-delete and merge are destructive. - Sign-in: Bearer private app token or service key. - Env prefix WCHUBSPOT_ (HUBSPOT_ is read by HubSpot's own tools, NEED-2710). Co-Authored-By: Claude Opus 5.5 --- contracts/wirecat.json | 1856 ++++- docs/commands.md | 2735 ++++++- docs/configuration.md | 2 +- docs/dev/API_COVERAGE.md | 309 +- docs/dev/TESTING.md | 2 +- docs/troubleshooting.md | 4 +- docs/usage.md | 2 +- scripts/generate.ts | 62 +- scripts/live.sh | 4 +- scripts/sandboxed.ts | 4 +- scripts/smoke-bundle.ts | 2 +- scripts/smoke.ts | 10 +- scripts/spec-model.ts | 37 +- skills/hubspot-cli/references/api.md | 5 +- .../references/api/api-advanced.md | 51 + .../hubspot-cli/references/api/api-basic.md | 1032 +++ .../hubspot-cli/references/api/api-batch.md | 690 ++ .../references/api/api-comments.md | 57 - .../hubspot-cli/references/api/api-search.md | 147 + spec/hubspot/account-info.json | 327 + spec/hubspot/associations.json | 4272 +++++++++++ spec/hubspot/calls.json | 3106 ++++++++ spec/hubspot/companies.json | 3162 ++++++++ spec/hubspot/contacts.json | 3213 ++++++++ spec/hubspot/crm-owners.json | 451 ++ spec/hubspot/deals.json | 3160 ++++++++ spec/hubspot/emails.json | 3106 ++++++++ spec/hubspot/leads.json | 3106 ++++++++ spec/hubspot/meetings.json | 3106 ++++++++ spec/hubspot/notes.json | 3106 ++++++++ spec/hubspot/openapi.json | 104 - spec/hubspot/pipelines.json | 3932 ++++++++++ spec/hubspot/properties.json | 4008 ++++++++++ spec/hubspot/provenance.json | 94 +- spec/hubspot/tasks.json | 3106 ++++++++ spec/hubspot/tickets.json | 3162 ++++++++ src/api.test.ts | 2 +- src/comments.test.ts | 4 +- src/generated/definitions.ts | 3084 +++++++- src/generated/manifest.ts | 6606 ++++++++++++++++- src/generated/schemas.ts | 1008 ++- src/generated/types.ts | 1205 ++- src/identity.ts | 2 +- src/mcp.test.ts | 2 +- src/program.test.ts | 12 +- src/testing/sandbox.ts | 10 +- 46 files changed, 63107 insertions(+), 360 deletions(-) create mode 100644 skills/hubspot-cli/references/api/api-advanced.md create mode 100644 skills/hubspot-cli/references/api/api-basic.md create mode 100644 skills/hubspot-cli/references/api/api-batch.md delete mode 100644 skills/hubspot-cli/references/api/api-comments.md create mode 100644 skills/hubspot-cli/references/api/api-search.md create mode 100644 spec/hubspot/account-info.json create mode 100644 spec/hubspot/associations.json create mode 100644 spec/hubspot/calls.json create mode 100644 spec/hubspot/companies.json create mode 100644 spec/hubspot/contacts.json create mode 100644 spec/hubspot/crm-owners.json create mode 100644 spec/hubspot/deals.json create mode 100644 spec/hubspot/emails.json create mode 100644 spec/hubspot/leads.json create mode 100644 spec/hubspot/meetings.json create mode 100644 spec/hubspot/notes.json delete mode 100644 spec/hubspot/openapi.json create mode 100644 spec/hubspot/pipelines.json create mode 100644 spec/hubspot/properties.json create mode 100644 spec/hubspot/tasks.json create mode 100644 spec/hubspot/tickets.json diff --git a/contracts/wirecat.json b/contracts/wirecat.json index a45f901..2b0d872 100644 --- a/contracts/wirecat.json +++ b/contracts/wirecat.json @@ -99,62 +99,1886 @@ { "path": [ "api", - "comments-list" + "contacts-list" ], - "summary": "List comments, newest first — read (GET /comments)", + "summary": "Retrieve contacts — read (GET /crm/objects/2026-03/contacts)", "effects": { "remote": "read", "local": "none" }, - "permission": "api.comments-list" + "permission": "api.contacts-list" }, { "path": [ "api", - "comments-create" + "contacts-create" ], - "summary": "Create a comment — write (POST /comments)", + "summary": "Create a contact — write (POST /crm/objects/2026-03/contacts)", "effects": { "remote": "write", "local": "none" }, - "permission": "api.comments-create" + "permission": "api.contacts-create" }, { "path": [ "api", - "comments-get" + "contacts-batch-archive" ], - "summary": "Show one comment — read (GET /comments/{comment_id})", + "summary": "Archive a batch of contacts — destructive (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.contacts-batch-archive" + }, + { + "path": [ + "api", + "contacts-batch-create" + ], + "summary": "Create a batch of contacts — write (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.contacts-batch-create" + }, + { + "path": [ + "api", + "contacts-batch-read" + ], + "summary": "Retrieve a batch of contacts — write (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.contacts-batch-read" + }, + { + "path": [ + "api", + "contacts-batch-update" + ], + "summary": "Update a batch of contacts — write (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.contacts-batch-update" + }, + { + "path": [ + "api", + "contacts-batch-upsert" + ], + "summary": "Create or update a batch of contacts — write (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.contacts-batch-upsert" + }, + { + "path": [ + "api", + "contacts-gdpr-delete" + ], + "summary": "Permanently delete a contact (GDPR-compliant) — destructive (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.contacts-gdpr-delete" + }, + { + "path": [ + "api", + "contacts-merge" + ], + "summary": "Merge two contacts — destructive (POST /crm/objects/2026-03/contacts/merge)", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.contacts-merge" + }, + { + "path": [ + "api", + "contacts-search" + ], + "summary": "Search for contacts — read (POST /crm/objects/2026-03/contacts/search)", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.contacts-search" + }, + { + "path": [ + "api", + "contacts-get" + ], + "summary": "Retrieve a contact — read (GET /crm/objects/2026-03/contacts/{contactId})", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.contacts-get" + }, + { + "path": [ + "api", + "contacts-update" + ], + "summary": "Update a contact — write (PATCH /crm/objects/2026-03/contacts/{contactId})", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.contacts-update" + }, + { + "path": [ + "api", + "contacts-delete" + ], + "summary": "Archive a contact — destructive (DELETE…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.contacts-delete" + }, + { + "path": [ + "api", + "associations-default-replace" + ], + "summary": "— write (PUT…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.associations-default-replace" + }, + { + "path": [ + "api", + "associations-replace" + ], + "summary": "— write (PUT…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.associations-replace" + }, + { + "path": [ + "api", + "associations-delete" + ], + "summary": "— destructive (DELETE…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.associations-delete" + }, + { + "path": [ + "api", + "companies-list" + ], + "summary": "Retrieve companies — read (GET /crm/objects/2026-03/companies)", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.companies-list" + }, + { + "path": [ + "api", + "companies-create" + ], + "summary": "Create a company — write (POST /crm/objects/2026-03/companies)", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.companies-create" + }, + { + "path": [ + "api", + "companies-batch-archive" + ], + "summary": "Archive a batch of companies — destructive (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.companies-batch-archive" + }, + { + "path": [ + "api", + "companies-batch-create" + ], + "summary": "Create a batch of companies — write (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.companies-batch-create" + }, + { + "path": [ + "api", + "companies-batch-read" + ], + "summary": "Retrieve a batch of companies — write (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.companies-batch-read" + }, + { + "path": [ + "api", + "companies-batch-update" + ], + "summary": "Update a batch of companies — write (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.companies-batch-update" + }, + { + "path": [ + "api", + "companies-batch-upsert" + ], + "summary": "Create or update a batch of companies by unique property values — write…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.companies-batch-upsert" + }, + { + "path": [ + "api", + "companies-merge" + ], + "summary": "Merge two companies — destructive (POST /crm/objects/2026-03/companies/merge)", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.companies-merge" + }, + { + "path": [ + "api", + "companies-search" + ], + "summary": "Search for companies — read (POST /crm/objects/2026-03/companies/search)", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.companies-search" + }, + { + "path": [ + "api", + "companies-get" + ], + "summary": "Retrieve a company — read (GET /crm/objects/2026-03/companies/{companyId})", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.companies-get" + }, + { + "path": [ + "api", + "companies-update" + ], + "summary": "Update a company — write (PATCH /crm/objects/2026-03/companies/{companyId})", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.companies-update" + }, + { + "path": [ + "api", + "companies-delete" + ], + "summary": "Archive a company — destructive (DELETE…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.companies-delete" + }, + { + "path": [ + "api", + "deals-list" + ], + "summary": "List — read (GET /crm/objects/2026-03/0-3)", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.deals-list" + }, + { + "path": [ + "api", + "deals-create" + ], + "summary": "Create — write (POST /crm/objects/2026-03/0-3)", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.deals-create" + }, + { + "path": [ + "api", + "deals-batch-archive" + ], + "summary": "Archive a batch of deals by ID — destructive (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.deals-batch-archive" + }, + { + "path": [ + "api", + "deals-batch-create" + ], + "summary": "Create a batch of deals — write (POST /crm/objects/2026-03/0-3/batch/create)", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.deals-batch-create" + }, + { + "path": [ + "api", + "deals-batch-read" + ], + "summary": "Read a batch of deals by internal ID, or unique property values — write…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.deals-batch-read" + }, + { + "path": [ + "api", + "deals-batch-update" + ], + "summary": "Update a batch of deals by internal ID, or unique property values — write…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.deals-batch-update" + }, + { + "path": [ + "api", + "deals-batch-upsert" + ], + "summary": "Create or update a batch of deals by unique property values — write (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.deals-batch-upsert" + }, + { + "path": [ + "api", + "deals-merge" + ], + "summary": "Merge two deals with same type — destructive (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.deals-merge" + }, + { + "path": [ + "api", + "deals-search" + ], + "summary": "Search for deals using various filters and criteria to retrieve specific…", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.deals-search" + }, + { + "path": [ + "api", + "deals-get" + ], + "summary": "Read — read (GET /crm/objects/2026-03/0-3/{dealId})", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.deals-get" + }, + { + "path": [ + "api", + "deals-update" + ], + "summary": "Update — write (PATCH /crm/objects/2026-03/0-3/{dealId})", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.deals-update" + }, + { + "path": [ + "api", + "deals-delete" + ], + "summary": "Archive — destructive (DELETE /crm/objects/2026-03/0-3/{dealId})", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.deals-delete" + }, + { + "path": [ + "api", + "tickets-list" + ], + "summary": "List — read (GET /crm/objects/2026-03/tickets)", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.tickets-list" + }, + { + "path": [ + "api", + "tickets-create" + ], + "summary": "Create — write (POST /crm/objects/2026-03/tickets)", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.tickets-create" + }, + { + "path": [ + "api", + "tickets-batch-archive" + ], + "summary": "Archive a batch of tickets by ID — destructive (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.tickets-batch-archive" + }, + { + "path": [ + "api", + "tickets-batch-create" + ], + "summary": "Create a batch of tickets — write (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.tickets-batch-create" + }, + { + "path": [ + "api", + "tickets-batch-read" + ], + "summary": "Read a batch of tickets by internal ID, or unique property values — write…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.tickets-batch-read" + }, + { + "path": [ + "api", + "tickets-batch-update" + ], + "summary": "Update a batch of tickets by internal ID, or unique property values — write…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.tickets-batch-update" + }, + { + "path": [ + "api", + "tickets-batch-upsert" + ], + "summary": "Create or update a batch of tickets by unique property values — write (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.tickets-batch-upsert" + }, + { + "path": [ + "api", + "tickets-merge" + ], + "summary": "Merge two tickets — destructive (POST /crm/objects/2026-03/tickets/merge)", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.tickets-merge" + }, + { + "path": [ + "api", + "tickets-search" + ], + "summary": "Search for tickets — read (POST /crm/objects/2026-03/tickets/search)", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.tickets-search" + }, + { + "path": [ + "api", + "tickets-get" + ], + "summary": "Read — read (GET /crm/objects/2026-03/tickets/{ticketId})", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.tickets-get" + }, + { + "path": [ + "api", + "tickets-update" + ], + "summary": "Update — write (PATCH /crm/objects/2026-03/tickets/{ticketId})", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.tickets-update" + }, + { + "path": [ + "api", + "tickets-delete" + ], + "summary": "Archive — destructive (DELETE /crm/objects/2026-03/tickets/{ticketId})", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.tickets-delete" + }, + { + "path": [ + "api", + "leads-list" + ], + "summary": "List — read (GET /crm/objects/2026-03/leads)", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.leads-list" + }, + { + "path": [ + "api", + "leads-create" + ], + "summary": "Create — write (POST /crm/objects/2026-03/leads)", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.leads-create" + }, + { + "path": [ + "api", + "leads-batch-archive" + ], + "summary": "Archive a batch of leads by ID — destructive (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.leads-batch-archive" + }, + { + "path": [ + "api", + "leads-batch-create" + ], + "summary": "Create a batch of leads — write (POST /crm/objects/2026-03/leads/batch/create)", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.leads-batch-create" + }, + { + "path": [ + "api", + "leads-batch-read" + ], + "summary": "Read a batch of leads by internal ID, or unique property values — write…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.leads-batch-read" + }, + { + "path": [ + "api", + "leads-batch-update" + ], + "summary": "Update a batch of leads by internal ID, or unique property values — write…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.leads-batch-update" + }, + { + "path": [ + "api", + "leads-batch-upsert" + ], + "summary": "Create or update a batch of leads by unique property values — write (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.leads-batch-upsert" + }, + { + "path": [ + "api", + "leads-search" + ], + "summary": "Search for leads using specified criteria. — read (POST…", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.leads-search" + }, + { + "path": [ + "api", + "leads-get" + ], + "summary": "Read — read (GET /crm/objects/2026-03/leads/{leadsId})", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.leads-get" + }, + { + "path": [ + "api", + "leads-update" + ], + "summary": "Update — write (PATCH /crm/objects/2026-03/leads/{leadsId})", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.leads-update" + }, + { + "path": [ + "api", + "leads-delete" + ], + "summary": "Archive — destructive (DELETE /crm/objects/2026-03/leads/{leadsId})", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.leads-delete" + }, + { + "path": [ + "api", + "notes-list" + ], + "summary": "List — read (GET /crm/objects/2026-03/notes)", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.notes-list" + }, + { + "path": [ + "api", + "notes-create" + ], + "summary": "Create — write (POST /crm/objects/2026-03/notes)", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.notes-create" + }, + { + "path": [ + "api", + "notes-batch-archive" + ], + "summary": "Archive a batch of notes by ID — destructive (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.notes-batch-archive" + }, + { + "path": [ + "api", + "notes-batch-create" + ], + "summary": "Create a batch of notes — write (POST /crm/objects/2026-03/notes/batch/create)", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.notes-batch-create" + }, + { + "path": [ + "api", + "notes-batch-read" + ], + "summary": "Read a batch of notes by internal ID, or unique property values — write…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.notes-batch-read" + }, + { + "path": [ + "api", + "notes-batch-update" + ], + "summary": "Update a batch of notes by internal ID, or unique property values — write…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.notes-batch-update" + }, + { + "path": [ + "api", + "notes-batch-upsert" + ], + "summary": "Create or update a batch of notes by unique property values — write (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.notes-batch-upsert" + }, + { + "path": [ + "api", + "notes-search" + ], + "summary": "Search for notes based on specified criteria. — read (POST…", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.notes-search" + }, + { + "path": [ + "api", + "notes-get" + ], + "summary": "Read — read (GET /crm/objects/2026-03/notes/{noteId})", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.notes-get" + }, + { + "path": [ + "api", + "notes-update" + ], + "summary": "Update — write (PATCH /crm/objects/2026-03/notes/{noteId})", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.notes-update" + }, + { + "path": [ + "api", + "notes-delete" + ], + "summary": "Archive — destructive (DELETE /crm/objects/2026-03/notes/{noteId})", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.notes-delete" + }, + { + "path": [ + "api", + "calls-list" + ], + "summary": "List — read (GET /crm/objects/2026-03/calls)", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.calls-list" + }, + { + "path": [ + "api", + "calls-create" + ], + "summary": "Create — write (POST /crm/objects/2026-03/calls)", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.calls-create" + }, + { + "path": [ + "api", + "calls-batch-archive" + ], + "summary": "Archive a batch of calls by ID — destructive (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.calls-batch-archive" + }, + { + "path": [ + "api", + "calls-batch-create" + ], + "summary": "Create a batch of calls — write (POST /crm/objects/2026-03/calls/batch/create)", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.calls-batch-create" + }, + { + "path": [ + "api", + "calls-batch-read" + ], + "summary": "Read a batch of calls by internal ID, or unique property values — write…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.calls-batch-read" + }, + { + "path": [ + "api", + "calls-batch-update" + ], + "summary": "Update a batch of calls by internal ID, or unique property values — write…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.calls-batch-update" + }, + { + "path": [ + "api", + "calls-batch-upsert" + ], + "summary": "Create or update a batch of calls by unique property values — write (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.calls-batch-upsert" + }, + { + "path": [ + "api", + "calls-search" + ], + "summary": "Search for calls — read (POST /crm/objects/2026-03/calls/search)", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.calls-search" + }, + { + "path": [ + "api", + "calls-get" + ], + "summary": "Read — read (GET /crm/objects/2026-03/calls/{callId})", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.calls-get" + }, + { + "path": [ + "api", + "calls-update" + ], + "summary": "Update — write (PATCH /crm/objects/2026-03/calls/{callId})", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.calls-update" + }, + { + "path": [ + "api", + "calls-delete" + ], + "summary": "Archive — destructive (DELETE /crm/objects/2026-03/calls/{callId})", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.calls-delete" + }, + { + "path": [ + "api", + "emails-list" + ], + "summary": "List — read (GET /crm/objects/2026-03/emails)", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.emails-list" + }, + { + "path": [ + "api", + "emails-create" + ], + "summary": "Create — write (POST /crm/objects/2026-03/emails)", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.emails-create" + }, + { + "path": [ + "api", + "emails-batch-archive" + ], + "summary": "Archive a batch of emails by ID — destructive (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.emails-batch-archive" + }, + { + "path": [ + "api", + "emails-batch-create" + ], + "summary": "Create a batch of emails — write (POST /crm/objects/2026-03/emails/batch/create)", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.emails-batch-create" + }, + { + "path": [ + "api", + "emails-batch-read" + ], + "summary": "Read a batch of emails by internal ID, or unique property values — write…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.emails-batch-read" + }, + { + "path": [ + "api", + "emails-batch-update" + ], + "summary": "Update a batch of emails by internal ID, or unique property values — write…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.emails-batch-update" + }, + { + "path": [ + "api", + "emails-batch-upsert" + ], + "summary": "Create or update a batch of emails by unique property values — write (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.emails-batch-upsert" + }, + { + "path": [ + "api", + "emails-search" + ], + "summary": "Search for emails using specified criteria and filters. — read (POST…", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.emails-search" + }, + { + "path": [ + "api", + "emails-get" + ], + "summary": "Read — read (GET /crm/objects/2026-03/emails/{emailId})", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.emails-get" + }, + { + "path": [ + "api", + "emails-update" + ], + "summary": "Update — write (PATCH /crm/objects/2026-03/emails/{emailId})", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.emails-update" + }, + { + "path": [ + "api", + "emails-delete" + ], + "summary": "Archive — destructive (DELETE /crm/objects/2026-03/emails/{emailId})", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.emails-delete" + }, + { + "path": [ + "api", + "meetings-list" + ], + "summary": "List — read (GET /crm/objects/2026-03/meetings)", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.meetings-list" + }, + { + "path": [ + "api", + "meetings-create" + ], + "summary": "Create — write (POST /crm/objects/2026-03/meetings)", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.meetings-create" + }, + { + "path": [ + "api", + "meetings-batch-archive" + ], + "summary": "Archive a batch of meetings by ID — destructive (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.meetings-batch-archive" + }, + { + "path": [ + "api", + "meetings-batch-create" + ], + "summary": "Create a batch of meetings — write (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.meetings-batch-create" + }, + { + "path": [ + "api", + "meetings-batch-read" + ], + "summary": "Read a batch of meetings by internal ID, or unique property values — write…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.meetings-batch-read" + }, + { + "path": [ + "api", + "meetings-batch-update" + ], + "summary": "Update a batch of meetings by internal ID, or unique property values — write…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.meetings-batch-update" + }, + { + "path": [ + "api", + "meetings-batch-upsert" + ], + "summary": "Create or update a batch of meetings by unique property values — write (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.meetings-batch-upsert" + }, + { + "path": [ + "api", + "meetings-search" + ], + "summary": "Search for meetings — read (POST /crm/objects/2026-03/meetings/search)", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.meetings-search" + }, + { + "path": [ + "api", + "meetings-get" + ], + "summary": "Read — read (GET /crm/objects/2026-03/meetings/{meetingId})", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.meetings-get" + }, + { + "path": [ + "api", + "meetings-update" + ], + "summary": "Update — write (PATCH /crm/objects/2026-03/meetings/{meetingId})", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.meetings-update" + }, + { + "path": [ + "api", + "meetings-delete" + ], + "summary": "Archive — destructive (DELETE /crm/objects/2026-03/meetings/{meetingId})", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.meetings-delete" + }, + { + "path": [ + "api", + "tasks-list" + ], + "summary": "List — read (GET /crm/objects/2026-03/tasks)", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.tasks-list" + }, + { + "path": [ + "api", + "tasks-create" + ], + "summary": "Create — write (POST /crm/objects/2026-03/tasks)", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.tasks-create" + }, + { + "path": [ + "api", + "tasks-batch-archive" + ], + "summary": "Archive a batch of tasks by ID — destructive (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.tasks-batch-archive" + }, + { + "path": [ + "api", + "tasks-batch-create" + ], + "summary": "Create a batch of tasks — write (POST /crm/objects/2026-03/tasks/batch/create)", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.tasks-batch-create" + }, + { + "path": [ + "api", + "tasks-batch-read" + ], + "summary": "Read a batch of tasks by internal ID, or unique property values — write…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.tasks-batch-read" + }, + { + "path": [ + "api", + "tasks-batch-update" + ], + "summary": "Update a batch of tasks by internal ID, or unique property values — write…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.tasks-batch-update" + }, + { + "path": [ + "api", + "tasks-batch-upsert" + ], + "summary": "Create or update a batch of tasks by unique property values — write (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.tasks-batch-upsert" + }, + { + "path": [ + "api", + "tasks-search" + ], + "summary": "Search for tasks using specified criteria. — read (POST…", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.tasks-search" + }, + { + "path": [ + "api", + "tasks-get" + ], + "summary": "Read — read (GET /crm/objects/2026-03/tasks/{taskId})", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.tasks-get" + }, + { + "path": [ + "api", + "tasks-update" + ], + "summary": "Update — write (PATCH /crm/objects/2026-03/tasks/{taskId})", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.tasks-update" + }, + { + "path": [ + "api", + "tasks-delete" + ], + "summary": "Archive — destructive (DELETE /crm/objects/2026-03/tasks/{taskId})", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.tasks-delete" + }, + { + "path": [ + "api", + "owners-list" + ], + "summary": "List owners — read (GET /crm/owners/2026-03)", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.owners-list" + }, + { + "path": [ + "api", + "owners-get" + ], + "summary": "Retrieve a specific owner by ID — read (GET /crm/owners/2026-03/{ownerId})", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.owners-get" + }, + { + "path": [ + "api", + "pipelines-list" + ], + "summary": "Retrieve all pipelines — read (GET /crm/pipelines/2026-03/{objectType})", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.pipelines-list" + }, + { + "path": [ + "api", + "pipelines-create" + ], + "summary": "Create a pipeline — write (POST /crm/pipelines/2026-03/{objectType})", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.pipelines-create" + }, + { + "path": [ + "api", + "pipelines-get" + ], + "summary": "Return a pipeline by ID — read (GET…", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.pipelines-get" + }, + { + "path": [ + "api", + "pipelines-replace" + ], + "summary": "Replace a pipeline — write (PUT…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.pipelines-replace" + }, + { + "path": [ + "api", + "pipelines-update" + ], + "summary": "Perform a partial update of the pipeline identified by pipelineId. — write…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.pipelines-update" + }, + { + "path": [ + "api", + "pipelines-delete" + ], + "summary": "Delete a pipeline — destructive (DELETE…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.pipelines-delete" + }, + { + "path": [ + "api", + "pipelines-audit-list" + ], + "summary": "Return an audit of all changes to the pipeline — read (GET…", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.pipelines-audit-list" + }, + { + "path": [ + "api", + "pipelines-stages-list" + ], + "summary": "Return all stages of a pipeline — read (GET…", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.pipelines-stages-list" + }, + { + "path": [ + "api", + "pipelines-stages-create" + ], + "summary": "Create a pipeline stage — write (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.pipelines-stages-create" + }, + { + "path": [ + "api", + "pipelines-stages-get" + ], + "summary": "Return a pipeline stage by ID — read (GET…", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.pipelines-stages-get" + }, + { + "path": [ + "api", + "pipelines-stages-replace" + ], + "summary": "Replace a pipeline stage — write (PUT…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.pipelines-stages-replace" + }, + { + "path": [ + "api", + "pipelines-stages-update" + ], + "summary": "Update specific properties of an existing pipeline stage. — write (PATCH…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.pipelines-stages-update" + }, + { + "path": [ + "api", + "pipelines-stages-delete" + ], + "summary": "Delete a pipeline stage — destructive (DELETE…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.pipelines-stages-delete" + }, + { + "path": [ + "api", + "pipelines-stages-audit-list" + ], + "summary": "Retrieve a reverse chronological list of all changes made to a specific…", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.pipelines-stages-audit-list" + }, + { + "path": [ + "api", + "properties-list" + ], + "summary": "Read all properties — read (GET /crm/properties/2026-03/{objectType})", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.properties-list" + }, + { + "path": [ + "api", + "properties-create" + ], + "summary": "Create a property — write (POST /crm/properties/2026-03/{objectType})", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.properties-create" + }, + { + "path": [ + "api", + "properties-batch-archive" + ], + "summary": "Archive a batch of properties — destructive (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.properties-batch-archive" + }, + { + "path": [ + "api", + "properties-batch-create" + ], + "summary": "Create a batch of properties — write (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.properties-batch-create" + }, + { + "path": [ + "api", + "properties-batch-read" + ], + "summary": "Read a batch of properties — write (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.properties-batch-read" + }, + { + "path": [ + "api", + "properties-groups-list" + ], + "summary": "Read all property groups — read (GET…", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.properties-groups-list" + }, + { + "path": [ + "api", + "properties-groups-create" + ], + "summary": "Create a property group — write (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.properties-groups-create" + }, + { + "path": [ + "api", + "properties-groups-get" + ], + "summary": "Read a property group — read (GET…", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.properties-groups-get" + }, + { + "path": [ + "api", + "properties-groups-update" + ], + "summary": "Update a property group — write (PATCH…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.properties-groups-update" + }, + { + "path": [ + "api", + "properties-groups-delete" + ], + "summary": "Archive a property group — destructive (DELETE…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.properties-groups-delete" + }, + { + "path": [ + "api", + "properties-get" + ], + "summary": "Read a property — read (GET /crm/properties/2026-03/{objectType}/{propertyName})", "effects": { "remote": "read", "local": "none" }, - "permission": "api.comments-get" + "permission": "api.properties-get" + }, + { + "path": [ + "api", + "properties-update" + ], + "summary": "Update a property — write (PATCH…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.properties-update" + }, + { + "path": [ + "api", + "properties-delete" + ], + "summary": "Archive a property — destructive (DELETE…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.properties-delete" + }, + { + "path": [ + "api", + "associations-usage-high-usage-report-update" + ], + "summary": "Report high usage — write (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.associations-usage-high-usage-report-update" + }, + { + "path": [ + "api", + "associations-batch-archive" + ], + "summary": "Remove associations — destructive (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.associations-batch-archive" + }, + { + "path": [ + "api", + "associations-batch-associate-default" + ], + "summary": "Create Default Associations — write (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.associations-batch-associate-default" + }, + { + "path": [ + "api", + "associations-batch-create" + ], + "summary": "Associate records (labelled) — write (POST…", + "effects": { + "remote": "write", + "local": "none" + }, + "permission": "api.associations-batch-create" }, { "path": [ "api", - "comments-update" + "associations-batch-labels-archive" ], - "summary": "Change a comment's text — write (PATCH /comments/{comment_id})", + "summary": "Delete Specific Labels — destructive (POST…", "effects": { "remote": "write", "local": "none" }, - "permission": "api.comments-update" + "permission": "api.associations-batch-labels-archive" }, { "path": [ "api", - "comments-delete" + "associations-batch-read" ], - "summary": "Delete a comment — destructive (DELETE /comments/{comment_id})", + "summary": "Retrieve associations — write (POST…", "effects": { "remote": "write", "local": "none" }, - "permission": "api.comments-delete" + "permission": "api.associations-batch-read" + }, + { + "path": [ + "api", + "search" + ], + "summary": "— read (POST /crm/objects/2026-03/{objectType}/search)", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.search" + }, + { + "path": [ + "api", + "associations-get" + ], + "summary": "Retrieve all associations by object type — read (GET…", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.associations-get" + }, + { + "path": [ + "api", + "account-info-api-usage-daily-private-apps-list" + ], + "summary": "Retrieve private app daily API usage — read (GET…", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.account-info-api-usage-daily-private-apps-list" + }, + { + "path": [ + "api", + "account-info-details-list" + ], + "summary": "Retrieve account details — read (GET /account-info/2026-03/details)", + "effects": { + "remote": "read", + "local": "none" + }, + "permission": "api.account-info-details-list" }, { "path": [ @@ -647,7 +2471,7 @@ "storeReset": null, "storage": { "app": "hubspot-cli", - "env": "HUBSPOT" + "env": "WCHUBSPOT" }, "settings": null } diff --git a/docs/commands.md b/docs/commands.md index dd42e99..d5916c1 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -5,7 +5,7 @@ Every command, option and exit code, generated from the program itself. For the same list as JSON, run `hubspot commands --json`. -**The first word is the profile**, a name you choose: `hubspot personal config show`. `HUBSPOT_PROFILE` +**The first word is the profile**, a name you choose: `hubspot personal config show`. `WCHUBSPOT_PROFILE` does the same for a whole shell session. No profile is assumed: a command that uses an account stops without one and lists the profiles on this computer. @@ -73,7 +73,7 @@ hubspot session start [options] ### `hubspot session status` -show where this profile's token comes from: HUBSPOT_TOKEN, the keyring or a file, never the token; --check asks Example Comments whose token it is +show where this profile's token comes from: WCHUBSPOT_TOKEN, the keyring or a file, never the token; --check asks Example Comments whose token it is ```sh hubspot session status [options] @@ -137,32 +137,36 @@ hubspot api show |---|---|---| | `operation` | required | the operation, as api list prints it. | -**Example:** `hubspot personal api show comments-list --json` +**Example:** `hubspot personal api show contacts-list --json` -### `hubspot api comments-list` +### `hubspot api contacts-list` -List comments, newest first — read (GET /comments) +Retrieve contacts — read (GET /crm/objects/2026-03/contacts) ```sh -hubspot api comments-list [options] +hubspot api contacts-list [options] ``` | Option | What it does | |---|---| -| `--limit ` | limit. | -| `--start-cursor ` | start_cursor. | +| `--after ` | The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. | +| `--archived ` | Whether to return only results that have been archived. | +| `--associations ` | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--limit ` | The maximum number of results to display per page. | +| `--properties ` | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. | | `--all` | read every page, as the API pages it. | -**Example:** `hubspot personal api comments-list` +**Example:** `hubspot personal api contacts-list` -### `hubspot api comments-create` +### `hubspot api contacts-create` -Create a comment — write (POST /comments) +Create a contact — write (POST /crm/objects/2026-03/contacts) **Changes something in the service.** ```sh -hubspot api comments-create [options] +hubspot api contacts-create [options] ``` | Option | What it does | @@ -170,55 +174,2724 @@ hubspot api comments-create [options] | `--body ` | the request body as JSON; - reads it from stdin. | | `--body-file ` | the request body from a JSON file; - is stdin. | -**Example:** `hubspot personal api comments-create` +**Example:** `hubspot personal api contacts-create` -### `hubspot api comments-get` +### `hubspot api contacts-batch-archive` -Show one comment — read (GET /comments/{comment_id}) +Archive a batch of contacts — destructive (POST /crm/objects/2026-03/contacts/batch/archive) + +**Changes something in the service.** + +```sh +hubspot api contacts-batch-archive [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api contacts-batch-archive` + +### `hubspot api contacts-batch-create` + +Create a batch of contacts — write (POST /crm/objects/2026-03/contacts/batch/create) + +**Changes something in the service.** + +```sh +hubspot api contacts-batch-create [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api contacts-batch-create` + +### `hubspot api contacts-batch-read` + +Retrieve a batch of contacts — write (POST /crm/objects/2026-03/contacts/batch/read) + +**Changes something in the service.** + +```sh +hubspot api contacts-batch-read [options] +``` + +| Option | What it does | +|---|---| +| `--archived ` | Whether to return only results that have been archived. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api contacts-batch-read` + +### `hubspot api contacts-batch-update` + +Update a batch of contacts — write (POST /crm/objects/2026-03/contacts/batch/update) + +**Changes something in the service.** + +```sh +hubspot api contacts-batch-update [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api contacts-batch-update` + +### `hubspot api contacts-batch-upsert` + +Create or update a batch of contacts — write (POST /crm/objects/2026-03/contacts/batch/upsert) + +**Changes something in the service.** + +```sh +hubspot api contacts-batch-upsert [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api contacts-batch-upsert` + +### `hubspot api contacts-gdpr-delete` + +Permanently delete a contact (GDPR-compliant) — destructive (POST /crm/objects/2026-03/contacts/gdpr-delete) + +**Changes something in the service.** + +```sh +hubspot api contacts-gdpr-delete [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api contacts-gdpr-delete` + +### `hubspot api contacts-merge` + +Merge two contacts — destructive (POST /crm/objects/2026-03/contacts/merge) + +**Changes something in the service.** + +```sh +hubspot api contacts-merge [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api contacts-merge` + +### `hubspot api contacts-search` + +Search for contacts — read (POST /crm/objects/2026-03/contacts/search) + +```sh +hubspot api contacts-search [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | +| `--all` | read every page, as the API pages it. | + +**Example:** `hubspot personal api contacts-search` + +### `hubspot api contacts-get` + +Retrieve a contact — read (GET /crm/objects/2026-03/contacts/{contactId}) + +```sh +hubspot api contacts-get [options] +``` + +| Option | What it does | +|---|---| +| `--contact-id ` | contactId. | +| `--archived ` | Whether to return only results that have been archived. | +| `--associations ` | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--id-property ` | The name of a property whose values are unique for this object type. | +| `--properties ` | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. | + +**Example:** `hubspot personal api contacts-get --contact-id ` + +### `hubspot api contacts-update` + +Update a contact — write (PATCH /crm/objects/2026-03/contacts/{contactId}) + +**Changes something in the service.** + +```sh +hubspot api contacts-update [options] +``` + +| Option | What it does | +|---|---| +| `--contact-id ` | contactId. | +| `--id-property ` | The name of a property whose values are unique for this object type. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api contacts-update --contact-id ` + +### `hubspot api contacts-delete` + +Archive a contact — destructive (DELETE /crm/objects/2026-03/contacts/{contactId}) + +**Changes something in the service.** + +```sh +hubspot api contacts-delete [options] +``` + +| Option | What it does | +|---|---| +| `--contact-id ` | contactId. | + +**Example:** `hubspot personal api contacts-delete --contact-id ` + +### `hubspot api associations-default-replace` + +— write (PUT /crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}) + +**Changes something in the service.** + +```sh +hubspot api associations-default-replace [options] +``` + +| Option | What it does | +|---|---| +| `--from-object-id ` | fromObjectId. | +| `--from-object-type ` | fromObjectType. | +| `--to-object-id ` | toObjectId. | +| `--to-object-type ` | toObjectType. | + +**Example:** `hubspot personal api associations-default-replace --from-object-id --from-object-type --to-object-id --to-object-type ` + +### `hubspot api associations-replace` + +— write (PUT /crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}) + +**Changes something in the service.** + +```sh +hubspot api associations-replace [options] +``` + +| Option | What it does | +|---|---| +| `--object-id ` | objectId. | +| `--object-type ` | objectType. | +| `--to-object-id ` | toObjectId. | +| `--to-object-type ` | toObjectType. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api associations-replace --object-id --object-type --to-object-id --to-object-type ` + +### `hubspot api associations-delete` + +— destructive (DELETE /crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}) + +**Changes something in the service.** + +```sh +hubspot api associations-delete [options] +``` + +| Option | What it does | +|---|---| +| `--object-id ` | objectId. | +| `--object-type ` | objectType. | +| `--to-object-id ` | toObjectId. | +| `--to-object-type ` | toObjectType. | + +**Example:** `hubspot personal api associations-delete --object-id --object-type --to-object-id --to-object-type ` + +### `hubspot api companies-list` + +Retrieve companies — read (GET /crm/objects/2026-03/companies) + +```sh +hubspot api companies-list [options] +``` + +| Option | What it does | +|---|---| +| `--after ` | The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. | +| `--archived ` | Whether to return only results that have been archived. | +| `--associations ` | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--limit ` | The maximum number of results to display per page. | +| `--properties ` | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. | +| `--all` | read every page, as the API pages it. | + +**Example:** `hubspot personal api companies-list` + +### `hubspot api companies-create` + +Create a company — write (POST /crm/objects/2026-03/companies) + +**Changes something in the service.** + +```sh +hubspot api companies-create [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api companies-create` + +### `hubspot api companies-batch-archive` + +Archive a batch of companies — destructive (POST /crm/objects/2026-03/companies/batch/archive) + +**Changes something in the service.** + +```sh +hubspot api companies-batch-archive [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api companies-batch-archive` + +### `hubspot api companies-batch-create` + +Create a batch of companies — write (POST /crm/objects/2026-03/companies/batch/create) + +**Changes something in the service.** + +```sh +hubspot api companies-batch-create [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api companies-batch-create` + +### `hubspot api companies-batch-read` + +Retrieve a batch of companies — write (POST /crm/objects/2026-03/companies/batch/read) + +**Changes something in the service.** + +```sh +hubspot api companies-batch-read [options] +``` + +| Option | What it does | +|---|---| +| `--archived ` | Whether to return only results that have been archived. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api companies-batch-read` + +### `hubspot api companies-batch-update` + +Update a batch of companies — write (POST /crm/objects/2026-03/companies/batch/update) + +**Changes something in the service.** + +```sh +hubspot api companies-batch-update [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api companies-batch-update` + +### `hubspot api companies-batch-upsert` + +Create or update a batch of companies by unique property values — write (POST /crm/objects/2026-03/companies/batch/upsert) + +**Changes something in the service.** + +```sh +hubspot api companies-batch-upsert [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api companies-batch-upsert` + +### `hubspot api companies-merge` + +Merge two companies — destructive (POST /crm/objects/2026-03/companies/merge) + +**Changes something in the service.** + +```sh +hubspot api companies-merge [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api companies-merge` + +### `hubspot api companies-search` + +Search for companies — read (POST /crm/objects/2026-03/companies/search) + +```sh +hubspot api companies-search [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | +| `--all` | read every page, as the API pages it. | + +**Example:** `hubspot personal api companies-search` + +### `hubspot api companies-get` + +Retrieve a company — read (GET /crm/objects/2026-03/companies/{companyId}) + +```sh +hubspot api companies-get [options] +``` + +| Option | What it does | +|---|---| +| `--company-id ` | companyId. | +| `--archived ` | Whether to return only results that have been archived. | +| `--associations ` | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--id-property ` | The name of a property whose values are unique for this object type. | +| `--properties ` | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. | + +**Example:** `hubspot personal api companies-get --company-id ` + +### `hubspot api companies-update` + +Update a company — write (PATCH /crm/objects/2026-03/companies/{companyId}) + +**Changes something in the service.** + +```sh +hubspot api companies-update [options] +``` + +| Option | What it does | +|---|---| +| `--company-id ` | companyId. | +| `--id-property ` | The name of a property whose values are unique for this object type. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api companies-update --company-id ` + +### `hubspot api companies-delete` + +Archive a company — destructive (DELETE /crm/objects/2026-03/companies/{companyId}) + +**Changes something in the service.** + +```sh +hubspot api companies-delete [options] +``` + +| Option | What it does | +|---|---| +| `--company-id ` | companyId. | + +**Example:** `hubspot personal api companies-delete --company-id ` + +### `hubspot api deals-list` + +List — read (GET /crm/objects/2026-03/0-3) + +```sh +hubspot api deals-list [options] +``` + +| Option | What it does | +|---|---| +| `--after ` | The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. | +| `--archived ` | Whether to return only results that have been archived. | +| `--associations ` | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--limit ` | The maximum number of results to display per page. | +| `--properties ` | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. | +| `--all` | read every page, as the API pages it. | + +**Example:** `hubspot personal api deals-list` + +### `hubspot api deals-create` + +Create — write (POST /crm/objects/2026-03/0-3) + +**Changes something in the service.** + +```sh +hubspot api deals-create [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api deals-create` + +### `hubspot api deals-batch-archive` + +Archive a batch of deals by ID — destructive (POST /crm/objects/2026-03/0-3/batch/archive) + +**Changes something in the service.** + +```sh +hubspot api deals-batch-archive [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api deals-batch-archive` + +### `hubspot api deals-batch-create` + +Create a batch of deals — write (POST /crm/objects/2026-03/0-3/batch/create) + +**Changes something in the service.** + +```sh +hubspot api deals-batch-create [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api deals-batch-create` + +### `hubspot api deals-batch-read` + +Read a batch of deals by internal ID, or unique property values — write (POST /crm/objects/2026-03/0-3/batch/read) + +**Changes something in the service.** + +```sh +hubspot api deals-batch-read [options] +``` + +| Option | What it does | +|---|---| +| `--archived ` | Whether to return only results that have been archived. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api deals-batch-read` + +### `hubspot api deals-batch-update` + +Update a batch of deals by internal ID, or unique property values — write (POST /crm/objects/2026-03/0-3/batch/update) + +**Changes something in the service.** + +```sh +hubspot api deals-batch-update [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api deals-batch-update` + +### `hubspot api deals-batch-upsert` + +Create or update a batch of deals by unique property values — write (POST /crm/objects/2026-03/0-3/batch/upsert) + +**Changes something in the service.** + +```sh +hubspot api deals-batch-upsert [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api deals-batch-upsert` + +### `hubspot api deals-merge` + +Merge two deals with same type — destructive (POST /crm/objects/2026-03/0-3/merge) + +**Changes something in the service.** + +```sh +hubspot api deals-merge [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api deals-merge` + +### `hubspot api deals-search` + +Search for deals using various filters and criteria to retrieve specific records. — read (POST /crm/objects/2026-03/0-3/search) + +```sh +hubspot api deals-search [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | +| `--all` | read every page, as the API pages it. | + +**Example:** `hubspot personal api deals-search` + +### `hubspot api deals-get` + +Read — read (GET /crm/objects/2026-03/0-3/{dealId}) + +```sh +hubspot api deals-get [options] +``` + +| Option | What it does | +|---|---| +| `--deal-id ` | dealId. | +| `--archived ` | Whether to return only results that have been archived. | +| `--associations ` | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--id-property ` | The name of a property whose values are unique for this object type. | +| `--properties ` | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. | + +**Example:** `hubspot personal api deals-get --deal-id ` + +### `hubspot api deals-update` + +Update — write (PATCH /crm/objects/2026-03/0-3/{dealId}) + +**Changes something in the service.** + +```sh +hubspot api deals-update [options] +``` + +| Option | What it does | +|---|---| +| `--deal-id ` | dealId. | +| `--id-property ` | The name of a property whose values are unique for this object type. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api deals-update --deal-id ` + +### `hubspot api deals-delete` + +Archive — destructive (DELETE /crm/objects/2026-03/0-3/{dealId}) + +**Changes something in the service.** + +```sh +hubspot api deals-delete [options] +``` + +| Option | What it does | +|---|---| +| `--deal-id ` | dealId. | + +**Example:** `hubspot personal api deals-delete --deal-id ` + +### `hubspot api tickets-list` + +List — read (GET /crm/objects/2026-03/tickets) + +```sh +hubspot api tickets-list [options] +``` + +| Option | What it does | +|---|---| +| `--after ` | The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. | +| `--archived ` | Whether to return only results that have been archived. | +| `--associations ` | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--limit ` | The maximum number of results to display per page. | +| `--properties ` | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. | +| `--all` | read every page, as the API pages it. | + +**Example:** `hubspot personal api tickets-list` + +### `hubspot api tickets-create` + +Create — write (POST /crm/objects/2026-03/tickets) + +**Changes something in the service.** + +```sh +hubspot api tickets-create [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api tickets-create` + +### `hubspot api tickets-batch-archive` + +Archive a batch of tickets by ID — destructive (POST /crm/objects/2026-03/tickets/batch/archive) + +**Changes something in the service.** + +```sh +hubspot api tickets-batch-archive [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api tickets-batch-archive` + +### `hubspot api tickets-batch-create` + +Create a batch of tickets — write (POST /crm/objects/2026-03/tickets/batch/create) + +**Changes something in the service.** + +```sh +hubspot api tickets-batch-create [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api tickets-batch-create` + +### `hubspot api tickets-batch-read` + +Read a batch of tickets by internal ID, or unique property values — write (POST /crm/objects/2026-03/tickets/batch/read) + +**Changes something in the service.** + +```sh +hubspot api tickets-batch-read [options] +``` + +| Option | What it does | +|---|---| +| `--archived ` | Whether to return only results that have been archived. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api tickets-batch-read` + +### `hubspot api tickets-batch-update` + +Update a batch of tickets by internal ID, or unique property values — write (POST /crm/objects/2026-03/tickets/batch/update) + +**Changes something in the service.** + +```sh +hubspot api tickets-batch-update [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api tickets-batch-update` + +### `hubspot api tickets-batch-upsert` + +Create or update a batch of tickets by unique property values — write (POST /crm/objects/2026-03/tickets/batch/upsert) + +**Changes something in the service.** + +```sh +hubspot api tickets-batch-upsert [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api tickets-batch-upsert` + +### `hubspot api tickets-merge` + +Merge two tickets — destructive (POST /crm/objects/2026-03/tickets/merge) + +**Changes something in the service.** + +```sh +hubspot api tickets-merge [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api tickets-merge` + +### `hubspot api tickets-search` + +Search for tickets — read (POST /crm/objects/2026-03/tickets/search) + +```sh +hubspot api tickets-search [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | +| `--all` | read every page, as the API pages it. | + +**Example:** `hubspot personal api tickets-search` + +### `hubspot api tickets-get` + +Read — read (GET /crm/objects/2026-03/tickets/{ticketId}) + +```sh +hubspot api tickets-get [options] +``` + +| Option | What it does | +|---|---| +| `--ticket-id ` | ticketId. | +| `--archived ` | Whether to return only results that have been archived. | +| `--associations ` | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--id-property ` | The name of a property whose values are unique for this object type. | +| `--properties ` | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. | + +**Example:** `hubspot personal api tickets-get --ticket-id ` + +### `hubspot api tickets-update` + +Update — write (PATCH /crm/objects/2026-03/tickets/{ticketId}) + +**Changes something in the service.** + +```sh +hubspot api tickets-update [options] +``` + +| Option | What it does | +|---|---| +| `--ticket-id ` | ticketId. | +| `--id-property ` | The name of a property whose values are unique for this object type. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api tickets-update --ticket-id ` + +### `hubspot api tickets-delete` + +Archive — destructive (DELETE /crm/objects/2026-03/tickets/{ticketId}) + +**Changes something in the service.** + +```sh +hubspot api tickets-delete [options] +``` + +| Option | What it does | +|---|---| +| `--ticket-id ` | ticketId. | + +**Example:** `hubspot personal api tickets-delete --ticket-id ` + +### `hubspot api leads-list` + +List — read (GET /crm/objects/2026-03/leads) + +```sh +hubspot api leads-list [options] +``` + +| Option | What it does | +|---|---| +| `--after ` | The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. | +| `--archived ` | Whether to return only results that have been archived. | +| `--associations ` | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--limit ` | The maximum number of results to display per page. | +| `--properties ` | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. | +| `--all` | read every page, as the API pages it. | + +**Example:** `hubspot personal api leads-list` + +### `hubspot api leads-create` + +Create — write (POST /crm/objects/2026-03/leads) + +**Changes something in the service.** + +```sh +hubspot api leads-create [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api leads-create` + +### `hubspot api leads-batch-archive` + +Archive a batch of leads by ID — destructive (POST /crm/objects/2026-03/leads/batch/archive) + +**Changes something in the service.** + +```sh +hubspot api leads-batch-archive [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api leads-batch-archive` + +### `hubspot api leads-batch-create` + +Create a batch of leads — write (POST /crm/objects/2026-03/leads/batch/create) + +**Changes something in the service.** + +```sh +hubspot api leads-batch-create [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api leads-batch-create` + +### `hubspot api leads-batch-read` + +Read a batch of leads by internal ID, or unique property values — write (POST /crm/objects/2026-03/leads/batch/read) + +**Changes something in the service.** + +```sh +hubspot api leads-batch-read [options] +``` + +| Option | What it does | +|---|---| +| `--archived ` | Whether to return only results that have been archived. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api leads-batch-read` + +### `hubspot api leads-batch-update` + +Update a batch of leads by internal ID, or unique property values — write (POST /crm/objects/2026-03/leads/batch/update) + +**Changes something in the service.** + +```sh +hubspot api leads-batch-update [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api leads-batch-update` + +### `hubspot api leads-batch-upsert` + +Create or update a batch of leads by unique property values — write (POST /crm/objects/2026-03/leads/batch/upsert) + +**Changes something in the service.** + +```sh +hubspot api leads-batch-upsert [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api leads-batch-upsert` + +### `hubspot api leads-search` + +Search for leads using specified criteria. — read (POST /crm/objects/2026-03/leads/search) + +```sh +hubspot api leads-search [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | +| `--all` | read every page, as the API pages it. | + +**Example:** `hubspot personal api leads-search` + +### `hubspot api leads-get` + +Read — read (GET /crm/objects/2026-03/leads/{leadsId}) + +```sh +hubspot api leads-get [options] +``` + +| Option | What it does | +|---|---| +| `--leads-id ` | leadsId. | +| `--archived ` | Whether to return only results that have been archived. | +| `--associations ` | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--id-property ` | The name of a property whose values are unique for this object type. | +| `--properties ` | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. | + +**Example:** `hubspot personal api leads-get --leads-id ` + +### `hubspot api leads-update` + +Update — write (PATCH /crm/objects/2026-03/leads/{leadsId}) + +**Changes something in the service.** + +```sh +hubspot api leads-update [options] +``` + +| Option | What it does | +|---|---| +| `--leads-id ` | leadsId. | +| `--id-property ` | The name of a property whose values are unique for this object type. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api leads-update --leads-id ` + +### `hubspot api leads-delete` + +Archive — destructive (DELETE /crm/objects/2026-03/leads/{leadsId}) + +**Changes something in the service.** + +```sh +hubspot api leads-delete [options] +``` + +| Option | What it does | +|---|---| +| `--leads-id ` | leadsId. | + +**Example:** `hubspot personal api leads-delete --leads-id ` + +### `hubspot api notes-list` + +List — read (GET /crm/objects/2026-03/notes) + +```sh +hubspot api notes-list [options] +``` + +| Option | What it does | +|---|---| +| `--after ` | The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. | +| `--archived ` | Whether to return only results that have been archived. | +| `--associations ` | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--limit ` | The maximum number of results to display per page. | +| `--properties ` | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. | +| `--all` | read every page, as the API pages it. | + +**Example:** `hubspot personal api notes-list` + +### `hubspot api notes-create` + +Create — write (POST /crm/objects/2026-03/notes) + +**Changes something in the service.** + +```sh +hubspot api notes-create [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api notes-create` + +### `hubspot api notes-batch-archive` + +Archive a batch of notes by ID — destructive (POST /crm/objects/2026-03/notes/batch/archive) + +**Changes something in the service.** + +```sh +hubspot api notes-batch-archive [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api notes-batch-archive` + +### `hubspot api notes-batch-create` + +Create a batch of notes — write (POST /crm/objects/2026-03/notes/batch/create) + +**Changes something in the service.** + +```sh +hubspot api notes-batch-create [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api notes-batch-create` + +### `hubspot api notes-batch-read` + +Read a batch of notes by internal ID, or unique property values — write (POST /crm/objects/2026-03/notes/batch/read) + +**Changes something in the service.** + +```sh +hubspot api notes-batch-read [options] +``` + +| Option | What it does | +|---|---| +| `--archived ` | Whether to return only results that have been archived. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api notes-batch-read` + +### `hubspot api notes-batch-update` + +Update a batch of notes by internal ID, or unique property values — write (POST /crm/objects/2026-03/notes/batch/update) + +**Changes something in the service.** + +```sh +hubspot api notes-batch-update [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api notes-batch-update` + +### `hubspot api notes-batch-upsert` + +Create or update a batch of notes by unique property values — write (POST /crm/objects/2026-03/notes/batch/upsert) + +**Changes something in the service.** + +```sh +hubspot api notes-batch-upsert [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api notes-batch-upsert` + +### `hubspot api notes-search` + +Search for notes based on specified criteria. — read (POST /crm/objects/2026-03/notes/search) + +```sh +hubspot api notes-search [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | +| `--all` | read every page, as the API pages it. | + +**Example:** `hubspot personal api notes-search` + +### `hubspot api notes-get` + +Read — read (GET /crm/objects/2026-03/notes/{noteId}) + +```sh +hubspot api notes-get [options] +``` + +| Option | What it does | +|---|---| +| `--note-id ` | noteId. | +| `--archived ` | Whether to return only results that have been archived. | +| `--associations ` | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--id-property ` | The name of a property whose values are unique for this object type. | +| `--properties ` | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. | + +**Example:** `hubspot personal api notes-get --note-id ` + +### `hubspot api notes-update` + +Update — write (PATCH /crm/objects/2026-03/notes/{noteId}) + +**Changes something in the service.** + +```sh +hubspot api notes-update [options] +``` + +| Option | What it does | +|---|---| +| `--note-id ` | noteId. | +| `--id-property ` | The name of a property whose values are unique for this object type. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api notes-update --note-id ` + +### `hubspot api notes-delete` + +Archive — destructive (DELETE /crm/objects/2026-03/notes/{noteId}) + +**Changes something in the service.** + +```sh +hubspot api notes-delete [options] +``` + +| Option | What it does | +|---|---| +| `--note-id ` | noteId. | + +**Example:** `hubspot personal api notes-delete --note-id ` + +### `hubspot api calls-list` + +List — read (GET /crm/objects/2026-03/calls) + +```sh +hubspot api calls-list [options] +``` + +| Option | What it does | +|---|---| +| `--after ` | The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. | +| `--archived ` | Whether to return only results that have been archived. | +| `--associations ` | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--limit ` | The maximum number of results to display per page. | +| `--properties ` | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. | +| `--all` | read every page, as the API pages it. | + +**Example:** `hubspot personal api calls-list` + +### `hubspot api calls-create` + +Create — write (POST /crm/objects/2026-03/calls) + +**Changes something in the service.** + +```sh +hubspot api calls-create [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api calls-create` + +### `hubspot api calls-batch-archive` + +Archive a batch of calls by ID — destructive (POST /crm/objects/2026-03/calls/batch/archive) + +**Changes something in the service.** + +```sh +hubspot api calls-batch-archive [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api calls-batch-archive` + +### `hubspot api calls-batch-create` + +Create a batch of calls — write (POST /crm/objects/2026-03/calls/batch/create) + +**Changes something in the service.** + +```sh +hubspot api calls-batch-create [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api calls-batch-create` + +### `hubspot api calls-batch-read` + +Read a batch of calls by internal ID, or unique property values — write (POST /crm/objects/2026-03/calls/batch/read) + +**Changes something in the service.** + +```sh +hubspot api calls-batch-read [options] +``` + +| Option | What it does | +|---|---| +| `--archived ` | Whether to return only results that have been archived. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api calls-batch-read` + +### `hubspot api calls-batch-update` + +Update a batch of calls by internal ID, or unique property values — write (POST /crm/objects/2026-03/calls/batch/update) + +**Changes something in the service.** + +```sh +hubspot api calls-batch-update [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api calls-batch-update` + +### `hubspot api calls-batch-upsert` + +Create or update a batch of calls by unique property values — write (POST /crm/objects/2026-03/calls/batch/upsert) + +**Changes something in the service.** + +```sh +hubspot api calls-batch-upsert [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api calls-batch-upsert` + +### `hubspot api calls-search` + +Search for calls — read (POST /crm/objects/2026-03/calls/search) + +```sh +hubspot api calls-search [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | +| `--all` | read every page, as the API pages it. | + +**Example:** `hubspot personal api calls-search` + +### `hubspot api calls-get` + +Read — read (GET /crm/objects/2026-03/calls/{callId}) + +```sh +hubspot api calls-get [options] +``` + +| Option | What it does | +|---|---| +| `--call-id ` | callId. | +| `--archived ` | Whether to return only results that have been archived. | +| `--associations ` | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--id-property ` | The name of a property whose values are unique for this object type. | +| `--properties ` | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. | + +**Example:** `hubspot personal api calls-get --call-id ` + +### `hubspot api calls-update` + +Update — write (PATCH /crm/objects/2026-03/calls/{callId}) + +**Changes something in the service.** + +```sh +hubspot api calls-update [options] +``` + +| Option | What it does | +|---|---| +| `--call-id ` | callId. | +| `--id-property ` | The name of a property whose values are unique for this object type. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api calls-update --call-id ` + +### `hubspot api calls-delete` + +Archive — destructive (DELETE /crm/objects/2026-03/calls/{callId}) + +**Changes something in the service.** + +```sh +hubspot api calls-delete [options] +``` + +| Option | What it does | +|---|---| +| `--call-id ` | callId. | + +**Example:** `hubspot personal api calls-delete --call-id ` + +### `hubspot api emails-list` + +List — read (GET /crm/objects/2026-03/emails) + +```sh +hubspot api emails-list [options] +``` + +| Option | What it does | +|---|---| +| `--after ` | The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. | +| `--archived ` | Whether to return only results that have been archived. | +| `--associations ` | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--limit ` | The maximum number of results to display per page. | +| `--properties ` | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. | +| `--all` | read every page, as the API pages it. | + +**Example:** `hubspot personal api emails-list` + +### `hubspot api emails-create` + +Create — write (POST /crm/objects/2026-03/emails) + +**Changes something in the service.** + +```sh +hubspot api emails-create [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api emails-create` + +### `hubspot api emails-batch-archive` + +Archive a batch of emails by ID — destructive (POST /crm/objects/2026-03/emails/batch/archive) + +**Changes something in the service.** + +```sh +hubspot api emails-batch-archive [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api emails-batch-archive` + +### `hubspot api emails-batch-create` + +Create a batch of emails — write (POST /crm/objects/2026-03/emails/batch/create) + +**Changes something in the service.** + +```sh +hubspot api emails-batch-create [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api emails-batch-create` + +### `hubspot api emails-batch-read` + +Read a batch of emails by internal ID, or unique property values — write (POST /crm/objects/2026-03/emails/batch/read) + +**Changes something in the service.** + +```sh +hubspot api emails-batch-read [options] +``` + +| Option | What it does | +|---|---| +| `--archived ` | Whether to return only results that have been archived. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api emails-batch-read` + +### `hubspot api emails-batch-update` + +Update a batch of emails by internal ID, or unique property values — write (POST /crm/objects/2026-03/emails/batch/update) + +**Changes something in the service.** + +```sh +hubspot api emails-batch-update [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api emails-batch-update` + +### `hubspot api emails-batch-upsert` + +Create or update a batch of emails by unique property values — write (POST /crm/objects/2026-03/emails/batch/upsert) + +**Changes something in the service.** + +```sh +hubspot api emails-batch-upsert [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api emails-batch-upsert` + +### `hubspot api emails-search` + +Search for emails using specified criteria and filters. — read (POST /crm/objects/2026-03/emails/search) + +```sh +hubspot api emails-search [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | +| `--all` | read every page, as the API pages it. | + +**Example:** `hubspot personal api emails-search` + +### `hubspot api emails-get` + +Read — read (GET /crm/objects/2026-03/emails/{emailId}) + +```sh +hubspot api emails-get [options] +``` + +| Option | What it does | +|---|---| +| `--email-id ` | emailId. | +| `--archived ` | Whether to return only results that have been archived. | +| `--associations ` | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--id-property ` | The name of a property whose values are unique for this object type. | +| `--properties ` | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. | + +**Example:** `hubspot personal api emails-get --email-id ` + +### `hubspot api emails-update` + +Update — write (PATCH /crm/objects/2026-03/emails/{emailId}) + +**Changes something in the service.** + +```sh +hubspot api emails-update [options] +``` + +| Option | What it does | +|---|---| +| `--email-id ` | emailId. | +| `--id-property ` | The name of a property whose values are unique for this object type. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api emails-update --email-id ` + +### `hubspot api emails-delete` + +Archive — destructive (DELETE /crm/objects/2026-03/emails/{emailId}) + +**Changes something in the service.** + +```sh +hubspot api emails-delete [options] +``` + +| Option | What it does | +|---|---| +| `--email-id ` | emailId. | + +**Example:** `hubspot personal api emails-delete --email-id ` + +### `hubspot api meetings-list` + +List — read (GET /crm/objects/2026-03/meetings) + +```sh +hubspot api meetings-list [options] +``` + +| Option | What it does | +|---|---| +| `--after ` | The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. | +| `--archived ` | Whether to return only results that have been archived. | +| `--associations ` | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--limit ` | The maximum number of results to display per page. | +| `--properties ` | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. | +| `--all` | read every page, as the API pages it. | + +**Example:** `hubspot personal api meetings-list` + +### `hubspot api meetings-create` + +Create — write (POST /crm/objects/2026-03/meetings) + +**Changes something in the service.** + +```sh +hubspot api meetings-create [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api meetings-create` + +### `hubspot api meetings-batch-archive` + +Archive a batch of meetings by ID — destructive (POST /crm/objects/2026-03/meetings/batch/archive) + +**Changes something in the service.** + +```sh +hubspot api meetings-batch-archive [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api meetings-batch-archive` + +### `hubspot api meetings-batch-create` + +Create a batch of meetings — write (POST /crm/objects/2026-03/meetings/batch/create) + +**Changes something in the service.** + +```sh +hubspot api meetings-batch-create [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api meetings-batch-create` + +### `hubspot api meetings-batch-read` + +Read a batch of meetings by internal ID, or unique property values — write (POST /crm/objects/2026-03/meetings/batch/read) + +**Changes something in the service.** + +```sh +hubspot api meetings-batch-read [options] +``` + +| Option | What it does | +|---|---| +| `--archived ` | Whether to return only results that have been archived. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api meetings-batch-read` + +### `hubspot api meetings-batch-update` + +Update a batch of meetings by internal ID, or unique property values — write (POST /crm/objects/2026-03/meetings/batch/update) + +**Changes something in the service.** + +```sh +hubspot api meetings-batch-update [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api meetings-batch-update` + +### `hubspot api meetings-batch-upsert` + +Create or update a batch of meetings by unique property values — write (POST /crm/objects/2026-03/meetings/batch/upsert) + +**Changes something in the service.** + +```sh +hubspot api meetings-batch-upsert [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api meetings-batch-upsert` + +### `hubspot api meetings-search` + +Search for meetings — read (POST /crm/objects/2026-03/meetings/search) + +```sh +hubspot api meetings-search [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | +| `--all` | read every page, as the API pages it. | + +**Example:** `hubspot personal api meetings-search` + +### `hubspot api meetings-get` + +Read — read (GET /crm/objects/2026-03/meetings/{meetingId}) + +```sh +hubspot api meetings-get [options] +``` + +| Option | What it does | +|---|---| +| `--meeting-id ` | meetingId. | +| `--archived ` | Whether to return only results that have been archived. | +| `--associations ` | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--id-property ` | The name of a property whose values are unique for this object type. | +| `--properties ` | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. | + +**Example:** `hubspot personal api meetings-get --meeting-id ` + +### `hubspot api meetings-update` + +Update — write (PATCH /crm/objects/2026-03/meetings/{meetingId}) + +**Changes something in the service.** + +```sh +hubspot api meetings-update [options] +``` + +| Option | What it does | +|---|---| +| `--meeting-id ` | meetingId. | +| `--id-property ` | The name of a property whose values are unique for this object type. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api meetings-update --meeting-id ` + +### `hubspot api meetings-delete` + +Archive — destructive (DELETE /crm/objects/2026-03/meetings/{meetingId}) + +**Changes something in the service.** + +```sh +hubspot api meetings-delete [options] +``` + +| Option | What it does | +|---|---| +| `--meeting-id ` | meetingId. | + +**Example:** `hubspot personal api meetings-delete --meeting-id ` + +### `hubspot api tasks-list` + +List — read (GET /crm/objects/2026-03/tasks) + +```sh +hubspot api tasks-list [options] +``` + +| Option | What it does | +|---|---| +| `--after ` | The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. | +| `--archived ` | Whether to return only results that have been archived. | +| `--associations ` | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--limit ` | The maximum number of results to display per page. | +| `--properties ` | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. | +| `--all` | read every page, as the API pages it. | + +**Example:** `hubspot personal api tasks-list` + +### `hubspot api tasks-create` + +Create — write (POST /crm/objects/2026-03/tasks) + +**Changes something in the service.** + +```sh +hubspot api tasks-create [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api tasks-create` + +### `hubspot api tasks-batch-archive` + +Archive a batch of tasks by ID — destructive (POST /crm/objects/2026-03/tasks/batch/archive) + +**Changes something in the service.** + +```sh +hubspot api tasks-batch-archive [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api tasks-batch-archive` + +### `hubspot api tasks-batch-create` + +Create a batch of tasks — write (POST /crm/objects/2026-03/tasks/batch/create) + +**Changes something in the service.** + +```sh +hubspot api tasks-batch-create [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api tasks-batch-create` + +### `hubspot api tasks-batch-read` + +Read a batch of tasks by internal ID, or unique property values — write (POST /crm/objects/2026-03/tasks/batch/read) + +**Changes something in the service.** + +```sh +hubspot api tasks-batch-read [options] +``` + +| Option | What it does | +|---|---| +| `--archived ` | Whether to return only results that have been archived. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api tasks-batch-read` + +### `hubspot api tasks-batch-update` + +Update a batch of tasks by internal ID, or unique property values — write (POST /crm/objects/2026-03/tasks/batch/update) + +**Changes something in the service.** + +```sh +hubspot api tasks-batch-update [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api tasks-batch-update` + +### `hubspot api tasks-batch-upsert` + +Create or update a batch of tasks by unique property values — write (POST /crm/objects/2026-03/tasks/batch/upsert) + +**Changes something in the service.** + +```sh +hubspot api tasks-batch-upsert [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api tasks-batch-upsert` + +### `hubspot api tasks-search` + +Search for tasks using specified criteria. — read (POST /crm/objects/2026-03/tasks/search) + +```sh +hubspot api tasks-search [options] +``` + +| Option | What it does | +|---|---| +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | +| `--all` | read every page, as the API pages it. | + +**Example:** `hubspot personal api tasks-search` + +### `hubspot api tasks-get` + +Read — read (GET /crm/objects/2026-03/tasks/{taskId}) + +```sh +hubspot api tasks-get [options] +``` + +| Option | What it does | +|---|---| +| `--task-id ` | taskId. | +| `--archived ` | Whether to return only results that have been archived. | +| `--associations ` | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--id-property ` | The name of a property whose values are unique for this object type. | +| `--properties ` | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. | + +**Example:** `hubspot personal api tasks-get --task-id ` + +### `hubspot api tasks-update` + +Update — write (PATCH /crm/objects/2026-03/tasks/{taskId}) + +**Changes something in the service.** + +```sh +hubspot api tasks-update [options] +``` + +| Option | What it does | +|---|---| +| `--task-id ` | taskId. | +| `--id-property ` | The name of a property whose values are unique for this object type. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api tasks-update --task-id ` + +### `hubspot api tasks-delete` + +Archive — destructive (DELETE /crm/objects/2026-03/tasks/{taskId}) + +**Changes something in the service.** + +```sh +hubspot api tasks-delete [options] +``` + +| Option | What it does | +|---|---| +| `--task-id ` | taskId. | + +**Example:** `hubspot personal api tasks-delete --task-id ` + +### `hubspot api owners-list` + +List owners — read (GET /crm/owners/2026-03) + +```sh +hubspot api owners-list [options] +``` + +| Option | What it does | +|---|---| +| `--after ` | The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. | +| `--archived ` | Whether to return only results that have been archived. | +| `--email ` | Filter by email address (optional). | +| `--limit ` | The maximum number of results to display per page. | +| `--all` | read every page, as the API pages it. | + +**Example:** `hubspot personal api owners-list` + +### `hubspot api owners-get` + +Retrieve a specific owner by ID — read (GET /crm/owners/2026-03/{ownerId}) + +```sh +hubspot api owners-get [options] +``` + +| Option | What it does | +|---|---| +| `--owner-id ` | The unique identifier of the owner to retrieve. | +| `--archived ` | Whether to return only results that have been archived. | +| `--id-property ` | Specifies which property to use for identifying the owner. Valid values are 'id' or 'userId'. Defaults to 'id'. | + +**Example:** `hubspot personal api owners-get --owner-id ` + +### `hubspot api pipelines-list` + +Retrieve all pipelines — read (GET /crm/pipelines/2026-03/{objectType}) + +```sh +hubspot api pipelines-list [options] +``` + +| Option | What it does | +|---|---| +| `--object-type ` | objectType. | + +**Example:** `hubspot personal api pipelines-list --object-type ` + +### `hubspot api pipelines-create` + +Create a pipeline — write (POST /crm/pipelines/2026-03/{objectType}) + +**Changes something in the service.** + +```sh +hubspot api pipelines-create [options] +``` + +| Option | What it does | +|---|---| +| `--object-type ` | objectType. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api pipelines-create --object-type ` + +### `hubspot api pipelines-get` + +Return a pipeline by ID — read (GET /crm/pipelines/2026-03/{objectType}/{pipelineId}) + +```sh +hubspot api pipelines-get [options] +``` + +| Option | What it does | +|---|---| +| `--object-type ` | objectType. | +| `--pipeline-id ` | pipelineId. | + +**Example:** `hubspot personal api pipelines-get --object-type --pipeline-id ` + +### `hubspot api pipelines-replace` + +Replace a pipeline — write (PUT /crm/pipelines/2026-03/{objectType}/{pipelineId}) + +**Changes something in the service.** + +```sh +hubspot api pipelines-replace [options] +``` + +| Option | What it does | +|---|---| +| `--object-type ` | objectType. | +| `--pipeline-id ` | pipelineId. | +| `--validate-deal-stage-usages-before-delete ` | validateDealStageUsagesBeforeDelete. | +| `--validate-references-before-delete ` | validateReferencesBeforeDelete. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api pipelines-replace --object-type --pipeline-id ` + +### `hubspot api pipelines-update` + +Perform a partial update of the pipeline identified by pipelineId. — write (PATCH /crm/pipelines/2026-03/{objectType}/{pipelineId}) + +**Changes something in the service.** + +```sh +hubspot api pipelines-update [options] +``` + +| Option | What it does | +|---|---| +| `--object-type ` | objectType. | +| `--pipeline-id ` | pipelineId. | +| `--validate-deal-stage-usages-before-delete ` | validateDealStageUsagesBeforeDelete. | +| `--validate-references-before-delete ` | validateReferencesBeforeDelete. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api pipelines-update --object-type --pipeline-id ` + +### `hubspot api pipelines-delete` + +Delete a pipeline — destructive (DELETE /crm/pipelines/2026-03/{objectType}/{pipelineId}) + +**Changes something in the service.** + +```sh +hubspot api pipelines-delete [options] +``` + +| Option | What it does | +|---|---| +| `--object-type ` | objectType. | +| `--pipeline-id ` | pipelineId. | +| `--validate-deal-stage-usages-before-delete ` | validateDealStageUsagesBeforeDelete. | +| `--validate-references-before-delete ` | validateReferencesBeforeDelete. | + +**Example:** `hubspot personal api pipelines-delete --object-type --pipeline-id ` + +### `hubspot api pipelines-audit-list` + +Return an audit of all changes to the pipeline — read (GET /crm/pipelines/2026-03/{objectType}/{pipelineId}/audit) + +```sh +hubspot api pipelines-audit-list [options] +``` + +| Option | What it does | +|---|---| +| `--object-type ` | objectType. | +| `--pipeline-id ` | pipelineId. | + +**Example:** `hubspot personal api pipelines-audit-list --object-type --pipeline-id ` + +### `hubspot api pipelines-stages-list` + +Return all stages of a pipeline — read (GET /crm/pipelines/2026-03/{objectType}/{pipelineId}/stages) + +```sh +hubspot api pipelines-stages-list [options] +``` + +| Option | What it does | +|---|---| +| `--object-type ` | objectType. | +| `--pipeline-id ` | pipelineId. | + +**Example:** `hubspot personal api pipelines-stages-list --object-type --pipeline-id ` + +### `hubspot api pipelines-stages-create` + +Create a pipeline stage — write (POST /crm/pipelines/2026-03/{objectType}/{pipelineId}/stages) + +**Changes something in the service.** + +```sh +hubspot api pipelines-stages-create [options] +``` + +| Option | What it does | +|---|---| +| `--object-type ` | objectType. | +| `--pipeline-id ` | pipelineId. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api pipelines-stages-create --object-type --pipeline-id ` + +### `hubspot api pipelines-stages-get` + +Return a pipeline stage by ID — read (GET /crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}) + +```sh +hubspot api pipelines-stages-get [options] +``` + +| Option | What it does | +|---|---| +| `--object-type ` | objectType. | +| `--pipeline-id ` | pipelineId. | +| `--stage-id ` | stageId. | + +**Example:** `hubspot personal api pipelines-stages-get --object-type --pipeline-id --stage-id ` + +### `hubspot api pipelines-stages-replace` + +Replace a pipeline stage — write (PUT /crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}) + +**Changes something in the service.** + +```sh +hubspot api pipelines-stages-replace [options] +``` + +| Option | What it does | +|---|---| +| `--object-type ` | objectType. | +| `--pipeline-id ` | pipelineId. | +| `--stage-id ` | stageId. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api pipelines-stages-replace --object-type --pipeline-id --stage-id ` + +### `hubspot api pipelines-stages-update` + +Update specific properties of an existing pipeline stage. — write (PATCH /crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}) + +**Changes something in the service.** + +```sh +hubspot api pipelines-stages-update [options] +``` + +| Option | What it does | +|---|---| +| `--object-type ` | objectType. | +| `--pipeline-id ` | pipelineId. | +| `--stage-id ` | stageId. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api pipelines-stages-update --object-type --pipeline-id --stage-id ` + +### `hubspot api pipelines-stages-delete` + +Delete a pipeline stage — destructive (DELETE /crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}) + +**Changes something in the service.** + +```sh +hubspot api pipelines-stages-delete [options] +``` + +| Option | What it does | +|---|---| +| `--object-type ` | objectType. | +| `--pipeline-id ` | pipelineId. | +| `--stage-id ` | stageId. | +| `--validate-references-before-delete ` | validateReferencesBeforeDelete. | + +**Example:** `hubspot personal api pipelines-stages-delete --object-type --pipeline-id --stage-id ` + +### `hubspot api pipelines-stages-audit-list` + +Retrieve a reverse chronological list of all changes made to a specific pipeline stage. — read (GET /crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}/audit) + +```sh +hubspot api pipelines-stages-audit-list [options] +``` + +| Option | What it does | +|---|---| +| `--object-type ` | objectType. | +| `--pipeline-id ` | pipelineId. | +| `--stage-id ` | stageId. | + +**Example:** `hubspot personal api pipelines-stages-audit-list --object-type --pipeline-id --stage-id ` + +### `hubspot api properties-list` + +Read all properties — read (GET /crm/properties/2026-03/{objectType}) + +```sh +hubspot api properties-list [options] +``` + +| Option | What it does | +|---|---| +| `--object-type ` | The type of CRM object for which properties are being retrieved, such as 'contacts', 'companies', etc. | +| `--archived ` | Whether to return only results that have been archived. | +| `--data-sensitivity ` | Filter properties based on data sensitivity level. Valid values are 'non_sensitive', 'sensitive', and 'highly_sensitive'. Defaults to 'non_sensitive'. | +| `--locale ` | Specify the locale to retrieve properties in a particular language or regional format. | +| `--properties ` | A comma-separated list of property names to include in the response. | + +**Example:** `hubspot personal api properties-list --object-type ` + +### `hubspot api properties-create` + +Create a property — write (POST /crm/properties/2026-03/{objectType}) + +**Changes something in the service.** + +```sh +hubspot api properties-create [options] +``` + +| Option | What it does | +|---|---| +| `--object-type ` | The type of object for which the property is being created, such as contacts, companies, or deals. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api properties-create --object-type ` + +### `hubspot api properties-batch-archive` + +Archive a batch of properties — destructive (POST /crm/properties/2026-03/{objectType}/batch/archive) + +**Changes something in the service.** + +```sh +hubspot api properties-batch-archive [options] +``` + +| Option | What it does | +|---|---| +| `--object-type ` | The type of object whose properties are to be archived. This is a required parameter and identifies the specific object type within HubSpot. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api properties-batch-archive --object-type ` + +### `hubspot api properties-batch-create` + +Create a batch of properties — write (POST /crm/properties/2026-03/{objectType}/batch/create) + +**Changes something in the service.** + +```sh +hubspot api properties-batch-create [options] +``` + +| Option | What it does | +|---|---| +| `--object-type ` | The type of CRM object for which the properties are being created, such as contacts, companies, or deals. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api properties-batch-create --object-type ` + +### `hubspot api properties-batch-read` + +Read a batch of properties — write (POST /crm/properties/2026-03/{objectType}/batch/read) + +**Changes something in the service.** + +```sh +hubspot api properties-batch-read [options] +``` + +| Option | What it does | +|---|---| +| `--object-type ` | The type of CRM object for which properties are being retrieved. This is a required path parameter. | +| `--locale ` | A string specifying the locale to use for the response. This can be used to tailor the response to a specific language or region. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api properties-batch-read --object-type ` + +### `hubspot api properties-groups-list` + +Read all property groups — read (GET /crm/properties/2026-03/{objectType}/groups) + +```sh +hubspot api properties-groups-list [options] +``` + +| Option | What it does | +|---|---| +| `--object-type ` | The type of CRM object for which to retrieve property groups, such as 'contacts' or 'deals'. | +| `--locale ` | The language locale to use for property group labels. This can help in displaying labels in the preferred language. | + +**Example:** `hubspot personal api properties-groups-list --object-type ` + +### `hubspot api properties-groups-create` + +Create a property group — write (POST /crm/properties/2026-03/{objectType}/groups) + +**Changes something in the service.** + +```sh +hubspot api properties-groups-create [options] +``` + +| Option | What it does | +|---|---| +| `--object-type ` | The type of object for which the property group is being created, such as contacts, companies, or deals. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api properties-groups-create --object-type ` + +### `hubspot api properties-groups-get` + +Read a property group — read (GET /crm/properties/2026-03/{objectType}/groups/{groupName}) + +```sh +hubspot api properties-groups-get [options] +``` + +| Option | What it does | +|---|---| +| `--group-name ` | The name of the property group to retrieve details for. | +| `--object-type ` | The type of CRM object for which the property group is being retrieved, such as contacts or deals. | +| `--locale ` | The language locale to use for the response. This can affect the language of the labels and descriptions returned. | + +**Example:** `hubspot personal api properties-groups-get --group-name --object-type ` + +### `hubspot api properties-groups-update` + +Update a property group — write (PATCH /crm/properties/2026-03/{objectType}/groups/{groupName}) + +**Changes something in the service.** + +```sh +hubspot api properties-groups-update [options] +``` + +| Option | What it does | +|---|---| +| `--group-name ` | The name of the property group to update. | +| `--object-type ` | The type of object for which the property group is being updated, such as contacts, companies, or deals. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api properties-groups-update --group-name --object-type ` + +### `hubspot api properties-groups-delete` + +Archive a property group — destructive (DELETE /crm/properties/2026-03/{objectType}/groups/{groupName}) + +**Changes something in the service.** + +```sh +hubspot api properties-groups-delete [options] +``` + +| Option | What it does | +|---|---| +| `--group-name ` | The unique name of the property group to be deleted. | +| `--object-type ` | The type of object for which the property group is defined, such as contacts, companies, or deals. | + +**Example:** `hubspot personal api properties-groups-delete --group-name --object-type ` + +### `hubspot api properties-get` + +Read a property — read (GET /crm/properties/2026-03/{objectType}/{propertyName}) + +```sh +hubspot api properties-get [options] +``` + +| Option | What it does | +|---|---| +| `--object-type ` | The type of object the property belongs to, such as 'contacts' or 'deals'. | +| `--property-name ` | The name of the property to retrieve. | +| `--archived ` | Whether to return only results that have been archived. | +| `--data-sensitivity ` | The level of data sensitivity to filter properties by. Valid values are 'non_sensitive', 'sensitive', and 'highly_sensitive'. Defaults to 'non_sensitive'. | +| `--locale ` | The locale to use for property labels and descriptions. | +| `--properties ` | A comma-separated list of property names to include in the response. | + +**Example:** `hubspot personal api properties-get --object-type --property-name ` + +### `hubspot api properties-update` + +Update a property — write (PATCH /crm/properties/2026-03/{objectType}/{propertyName}) + +**Changes something in the service.** + +```sh +hubspot api properties-update [options] +``` + +| Option | What it does | +|---|---| +| `--object-type ` | The type of object for which the property is being updated, such as contacts, companies, or deals. | +| `--property-name ` | The unique name of the property to update. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api properties-update --object-type --property-name ` + +### `hubspot api properties-delete` + +Archive a property — destructive (DELETE /crm/properties/2026-03/{objectType}/{propertyName}) + +**Changes something in the service.** + +```sh +hubspot api properties-delete [options] +``` + +| Option | What it does | +|---|---| +| `--object-type ` | The type of CRM object that the property belongs to, such as contacts, companies, or deals. | +| `--property-name ` | The unique name of the property to delete. | + +**Example:** `hubspot personal api properties-delete --object-type --property-name ` + +### `hubspot api associations-usage-high-usage-report-update` + +Report high usage — write (POST /crm/associations/2026-03/usage/high-usage-report/{userId}) + +**Changes something in the service.** + +```sh +hubspot api associations-usage-high-usage-report-update [options] +``` + +| Option | What it does | +|---|---| +| `--user-id ` | userId. | + +**Example:** `hubspot personal api associations-usage-high-usage-report-update --user-id ` + +### `hubspot api associations-batch-archive` + +Remove associations — destructive (POST /crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/archive) + +**Changes something in the service.** + +```sh +hubspot api associations-batch-archive [options] +``` + +| Option | What it does | +|---|---| +| `--from-object-type ` | fromObjectType. | +| `--to-object-type ` | toObjectType. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api associations-batch-archive --from-object-type --to-object-type ` + +### `hubspot api associations-batch-associate-default` + +Create Default Associations — write (POST /crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/associate/default) + +**Changes something in the service.** + +```sh +hubspot api associations-batch-associate-default [options] +``` + +| Option | What it does | +|---|---| +| `--from-object-type ` | fromObjectType. | +| `--to-object-type ` | toObjectType. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api associations-batch-associate-default --from-object-type --to-object-type ` + +### `hubspot api associations-batch-create` + +Associate records (labelled) — write (POST /crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/create) + +**Changes something in the service.** ```sh -hubspot api comments-get [options] +hubspot api associations-batch-create [options] ``` | Option | What it does | |---|---| -| `--comment-id ` | comment_id. | +| `--from-object-type ` | fromObjectType. | +| `--to-object-type ` | toObjectType. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | -**Example:** `hubspot personal api comments-get --comment-id ` +**Example:** `hubspot personal api associations-batch-create --from-object-type --to-object-type ` -### `hubspot api comments-update` +### `hubspot api associations-batch-labels-archive` -Change a comment's text — write (PATCH /comments/{comment_id}) +Delete Specific Labels — destructive (POST /crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/labels/archive) **Changes something in the service.** ```sh -hubspot api comments-update [options] +hubspot api associations-batch-labels-archive [options] ``` | Option | What it does | |---|---| -| `--comment-id ` | comment_id. | +| `--from-object-type ` | fromObjectType. | +| `--to-object-type ` | toObjectType. | | `--body ` | the request body as JSON; - reads it from stdin. | | `--body-file ` | the request body from a JSON file; - is stdin. | -**Example:** `hubspot personal api comments-update --comment-id ` +**Example:** `hubspot personal api associations-batch-labels-archive --from-object-type --to-object-type ` -### `hubspot api comments-delete` +### `hubspot api associations-batch-read` -Delete a comment — destructive (DELETE /comments/{comment_id}) +Retrieve associations — write (POST /crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/read) **Changes something in the service.** ```sh -hubspot api comments-delete [options] +hubspot api associations-batch-read [options] +``` + +| Option | What it does | +|---|---| +| `--from-object-type ` | fromObjectType. | +| `--to-object-type ` | toObjectType. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | + +**Example:** `hubspot personal api associations-batch-read --from-object-type --to-object-type ` + +### `hubspot api search` + +— read (POST /crm/objects/2026-03/{objectType}/search) + +```sh +hubspot api search [options] +``` + +| Option | What it does | +|---|---| +| `--object-type ` | objectType. | +| `--body ` | the request body as JSON; - reads it from stdin. | +| `--body-file ` | the request body from a JSON file; - is stdin. | +| `--all` | read every page, as the API pages it. | + +**Example:** `hubspot personal api search --object-type ` + +### `hubspot api associations-get` + +Retrieve all associations by object type — read (GET /crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}) + +```sh +hubspot api associations-get [options] ``` | Option | What it does | |---|---| -| `--comment-id ` | comment_id. | +| `--object-id ` | objectId. | +| `--object-type ` | objectType. | +| `--to-object-type ` | toObjectType. | +| `--after ` | The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. | +| `--limit ` | The maximum number of results to display per page. | +| `--all` | read every page, as the API pages it. | + +**Example:** `hubspot personal api associations-get --object-id --object-type --to-object-type ` + +### `hubspot api account-info-api-usage-daily-private-apps-list` + +Retrieve private app daily API usage — read (GET /account-info/2026-03/api-usage/daily/private-apps) + +```sh +hubspot api account-info-api-usage-daily-private-apps-list +``` + +**Example:** `hubspot personal api account-info-api-usage-daily-private-apps-list` -**Example:** `hubspot personal api comments-delete --comment-id ` +### `hubspot api account-info-details-list` + +Retrieve account details — read (GET /account-info/2026-03/details) + +```sh +hubspot api account-info-details-list +``` + +**Example:** `hubspot personal api account-info-details-list` ## `hubspot comments` @@ -352,9 +3025,13 @@ the instructions an agent is given for this tool print SKILL.md — `hubspot skill install` puts it where Claude Code, Codex, Gemini CLI and OpenClaw look for it, and where Hermes does on request; --for prints the copy already there ```sh -hubspot skill show [options] +hubspot skill show [name] [options] ``` +| Argument | | What it is | +|---|---|---| +| `name` | optional | a part of this skill, or a skill shipped for a task: api-search, api-batch, api-basic, api-advanced, api. | + | Option | What it does | |---|---| | `--for ` | print the copy installed for these agents instead of this version's. One of: `claude`, `agents`. | diff --git a/docs/configuration.md b/docs/configuration.md index 7b72a6c..47890cc 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -14,7 +14,7 @@ hubspot personal config unset limit ## Permissions `permissions` decides what a command may do for this profile: `allow`, `ask`, `readonly` or `deny`, per permission -key. Over MCP there is no one to ask, so `ask` lets the command run. `HUBSPOT_READ_ONLY=1` refuses every write, whatever +key. Over MCP there is no one to ask, so `ask` lets the command run. `WCHUBSPOT_READ_ONLY=1` refuses every write, whatever the permissions say. ## Run records diff --git a/docs/dev/API_COVERAGE.md b/docs/dev/API_COVERAGE.md index b8bb969..b1cb779 100644 --- a/docs/dev/API_COVERAGE.md +++ b/docs/dev/API_COVERAGE.md @@ -6,24 +6,317 @@ Run: pnpm generate # API coverage -5 operations from openapi 1. +157 operations from openapi 1. | Operation | Call | Command | Effect | Request source | Status | Summary | |---|---|---|---|---|---|---| -| `listComments` | `GET /comments` | `hubspot api comments-list` | read | — | generated | List comments, newest first | -| `createComment` | `POST /comments` | `hubspot api comments-create` | write | contract | generated | Create a comment | -| `getComment` | `GET /comments/{comment_id}` | `hubspot api comments-get` | read | — | generated | Show one comment | -| `updateComment` | `PATCH /comments/{comment_id}` | `hubspot api comments-update` | write | contract | generated | Change a comment's text | -| `deleteComment` | `DELETE /comments/{comment_id}` | `hubspot api comments-delete` | destructive | — | generated | Delete a comment | +| `get-/crm/objects/2026-03/contacts_getPage` | `GET /crm/objects/2026-03/contacts` | `hubspot api contacts-list` | read | — | generated | Retrieve contacts | +| `post-/crm/objects/2026-03/contacts_create` | `POST /crm/objects/2026-03/contacts` | `hubspot api contacts-create` | write | contract | generated | Create a contact | +| `post-/crm/objects/2026-03/contacts/batch/archive_archive` | `POST /crm/objects/2026-03/contacts/batch/archive` | `hubspot api contacts-batch-archive` | destructive | contract | generated | Archive a batch of contacts | +| `post-/crm/objects/2026-03/contacts/batch/create_create` | `POST /crm/objects/2026-03/contacts/batch/create` | `hubspot api contacts-batch-create` | write | contract | generated | Create a batch of contacts | +| `post-/crm/objects/2026-03/contacts/batch/read_read` | `POST /crm/objects/2026-03/contacts/batch/read` | `hubspot api contacts-batch-read` | write | contract | generated | Retrieve a batch of contacts | +| `post-/crm/objects/2026-03/contacts/batch/update_update` | `POST /crm/objects/2026-03/contacts/batch/update` | `hubspot api contacts-batch-update` | write | contract | generated | Update a batch of contacts | +| `post-/crm/objects/2026-03/contacts/batch/upsert_upsert` | `POST /crm/objects/2026-03/contacts/batch/upsert` | `hubspot api contacts-batch-upsert` | write | contract | generated | Create or update a batch of contacts | +| `post-/crm/objects/2026-03/contacts/gdpr-delete_purge` | `POST /crm/objects/2026-03/contacts/gdpr-delete` | `hubspot api contacts-gdpr-delete` | destructive | contract | generated | Permanently delete a contact (GDPR-compliant) | +| `post-/crm/objects/2026-03/contacts/merge_merge` | `POST /crm/objects/2026-03/contacts/merge` | `hubspot api contacts-merge` | destructive | contract | generated | Merge two contacts | +| `post-/crm/objects/2026-03/contacts/search_doSearch` | `POST /crm/objects/2026-03/contacts/search` | `hubspot api contacts-search` | read | contract | generated | Search for contacts | +| `get-/crm/objects/2026-03/contacts/{contactId}_getById` | `GET /crm/objects/2026-03/contacts/{contactId}` | `hubspot api contacts-get` | read | — | generated | Retrieve a contact | +| `patch-/crm/objects/2026-03/contacts/{contactId}_update` | `PATCH /crm/objects/2026-03/contacts/{contactId}` | `hubspot api contacts-update` | write | contract | generated | Update a contact | +| `delete-/crm/objects/2026-03/contacts/{contactId}_archive` | `DELETE /crm/objects/2026-03/contacts/{contactId}` | `hubspot api contacts-delete` | destructive | — | generated | Archive a contact | +| `put-/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}` | `PUT /crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}` | `hubspot api associations-default-replace` | write | — | generated | | +| `put-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}` | `PUT /crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}` | `hubspot api associations-replace` | write | contract | generated | | +| `delete-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}` | `DELETE /crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}` | `hubspot api associations-delete` | destructive | — | generated | | +| `get-/crm/objects/2026-03/companies_getPage` | `GET /crm/objects/2026-03/companies` | `hubspot api companies-list` | read | — | generated | Retrieve companies | +| `post-/crm/objects/2026-03/companies_create` | `POST /crm/objects/2026-03/companies` | `hubspot api companies-create` | write | contract | generated | Create a company | +| `post-/crm/objects/2026-03/companies/batch/archive_archive` | `POST /crm/objects/2026-03/companies/batch/archive` | `hubspot api companies-batch-archive` | destructive | contract | generated | Archive a batch of companies | +| `post-/crm/objects/2026-03/companies/batch/create_create` | `POST /crm/objects/2026-03/companies/batch/create` | `hubspot api companies-batch-create` | write | contract | generated | Create a batch of companies | +| `post-/crm/objects/2026-03/companies/batch/read_read` | `POST /crm/objects/2026-03/companies/batch/read` | `hubspot api companies-batch-read` | write | contract | generated | Retrieve a batch of companies | +| `post-/crm/objects/2026-03/companies/batch/update_update` | `POST /crm/objects/2026-03/companies/batch/update` | `hubspot api companies-batch-update` | write | contract | generated | Update a batch of companies | +| `post-/crm/objects/2026-03/companies/batch/upsert_upsert` | `POST /crm/objects/2026-03/companies/batch/upsert` | `hubspot api companies-batch-upsert` | write | contract | generated | Create or update a batch of companies by unique property values | +| `post-/crm/objects/2026-03/companies/merge_merge` | `POST /crm/objects/2026-03/companies/merge` | `hubspot api companies-merge` | destructive | contract | generated | Merge two companies | +| `post-/crm/objects/2026-03/companies/search_doSearch` | `POST /crm/objects/2026-03/companies/search` | `hubspot api companies-search` | read | contract | generated | Search for companies | +| `get-/crm/objects/2026-03/companies/{companyId}_getById` | `GET /crm/objects/2026-03/companies/{companyId}` | `hubspot api companies-get` | read | — | generated | Retrieve a company | +| `patch-/crm/objects/2026-03/companies/{companyId}_update` | `PATCH /crm/objects/2026-03/companies/{companyId}` | `hubspot api companies-update` | write | contract | generated | Update a company | +| `delete-/crm/objects/2026-03/companies/{companyId}_archive` | `DELETE /crm/objects/2026-03/companies/{companyId}` | `hubspot api companies-delete` | destructive | — | generated | Archive a company | +| `get-/crm/objects/2026-03/0-3_getPage` | `GET /crm/objects/2026-03/0-3` | `hubspot api deals-list` | read | — | generated | List | +| `post-/crm/objects/2026-03/0-3_create` | `POST /crm/objects/2026-03/0-3` | `hubspot api deals-create` | write | contract | generated | Create | +| `post-/crm/objects/2026-03/0-3/batch/archive_archive` | `POST /crm/objects/2026-03/0-3/batch/archive` | `hubspot api deals-batch-archive` | destructive | contract | generated | Archive a batch of deals by ID | +| `post-/crm/objects/2026-03/0-3/batch/create_create` | `POST /crm/objects/2026-03/0-3/batch/create` | `hubspot api deals-batch-create` | write | contract | generated | Create a batch of deals | +| `post-/crm/objects/2026-03/0-3/batch/read_read` | `POST /crm/objects/2026-03/0-3/batch/read` | `hubspot api deals-batch-read` | write | contract | generated | Read a batch of deals by internal ID, or unique property values | +| `post-/crm/objects/2026-03/0-3/batch/update_update` | `POST /crm/objects/2026-03/0-3/batch/update` | `hubspot api deals-batch-update` | write | contract | generated | Update a batch of deals by internal ID, or unique property values | +| `post-/crm/objects/2026-03/0-3/batch/upsert_upsert` | `POST /crm/objects/2026-03/0-3/batch/upsert` | `hubspot api deals-batch-upsert` | write | contract | generated | Create or update a batch of deals by unique property values | +| `post-/crm/objects/2026-03/0-3/merge_merge` | `POST /crm/objects/2026-03/0-3/merge` | `hubspot api deals-merge` | destructive | contract | generated | Merge two deals with same type | +| `post-/crm/objects/2026-03/0-3/search_doSearch` | `POST /crm/objects/2026-03/0-3/search` | `hubspot api deals-search` | read | contract | generated | Search for deals using various filters and criteria to retrieve specific records. | +| `get-/crm/objects/2026-03/0-3/{dealId}_getById` | `GET /crm/objects/2026-03/0-3/{dealId}` | `hubspot api deals-get` | read | — | generated | Read | +| `patch-/crm/objects/2026-03/0-3/{dealId}_update` | `PATCH /crm/objects/2026-03/0-3/{dealId}` | `hubspot api deals-update` | write | contract | generated | Update | +| `delete-/crm/objects/2026-03/0-3/{dealId}_archive` | `DELETE /crm/objects/2026-03/0-3/{dealId}` | `hubspot api deals-delete` | destructive | — | generated | Archive | +| `get-/crm/objects/2026-03/tickets_getPage` | `GET /crm/objects/2026-03/tickets` | `hubspot api tickets-list` | read | — | generated | List | +| `post-/crm/objects/2026-03/tickets_create` | `POST /crm/objects/2026-03/tickets` | `hubspot api tickets-create` | write | contract | generated | Create | +| `post-/crm/objects/2026-03/tickets/batch/archive_archive` | `POST /crm/objects/2026-03/tickets/batch/archive` | `hubspot api tickets-batch-archive` | destructive | contract | generated | Archive a batch of tickets by ID | +| `post-/crm/objects/2026-03/tickets/batch/create_create` | `POST /crm/objects/2026-03/tickets/batch/create` | `hubspot api tickets-batch-create` | write | contract | generated | Create a batch of tickets | +| `post-/crm/objects/2026-03/tickets/batch/read_read` | `POST /crm/objects/2026-03/tickets/batch/read` | `hubspot api tickets-batch-read` | write | contract | generated | Read a batch of tickets by internal ID, or unique property values | +| `post-/crm/objects/2026-03/tickets/batch/update_update` | `POST /crm/objects/2026-03/tickets/batch/update` | `hubspot api tickets-batch-update` | write | contract | generated | Update a batch of tickets by internal ID, or unique property values | +| `post-/crm/objects/2026-03/tickets/batch/upsert_upsert` | `POST /crm/objects/2026-03/tickets/batch/upsert` | `hubspot api tickets-batch-upsert` | write | contract | generated | Create or update a batch of tickets by unique property values | +| `post-/crm/objects/2026-03/tickets/merge_merge` | `POST /crm/objects/2026-03/tickets/merge` | `hubspot api tickets-merge` | destructive | contract | generated | Merge two tickets | +| `post-/crm/objects/2026-03/tickets/search_doSearch` | `POST /crm/objects/2026-03/tickets/search` | `hubspot api tickets-search` | read | contract | generated | Search for tickets | +| `get-/crm/objects/2026-03/tickets/{ticketId}_getById` | `GET /crm/objects/2026-03/tickets/{ticketId}` | `hubspot api tickets-get` | read | — | generated | Read | +| `patch-/crm/objects/2026-03/tickets/{ticketId}_update` | `PATCH /crm/objects/2026-03/tickets/{ticketId}` | `hubspot api tickets-update` | write | contract | generated | Update | +| `delete-/crm/objects/2026-03/tickets/{ticketId}_archive` | `DELETE /crm/objects/2026-03/tickets/{ticketId}` | `hubspot api tickets-delete` | destructive | — | generated | Archive | +| `get-/crm/objects/2026-03/leads_getPage` | `GET /crm/objects/2026-03/leads` | `hubspot api leads-list` | read | — | generated | List | +| `post-/crm/objects/2026-03/leads_create` | `POST /crm/objects/2026-03/leads` | `hubspot api leads-create` | write | contract | generated | Create | +| `post-/crm/objects/2026-03/leads/batch/archive_archive` | `POST /crm/objects/2026-03/leads/batch/archive` | `hubspot api leads-batch-archive` | destructive | contract | generated | Archive a batch of leads by ID | +| `post-/crm/objects/2026-03/leads/batch/create_create` | `POST /crm/objects/2026-03/leads/batch/create` | `hubspot api leads-batch-create` | write | contract | generated | Create a batch of leads | +| `post-/crm/objects/2026-03/leads/batch/read_read` | `POST /crm/objects/2026-03/leads/batch/read` | `hubspot api leads-batch-read` | write | contract | generated | Read a batch of leads by internal ID, or unique property values | +| `post-/crm/objects/2026-03/leads/batch/update_update` | `POST /crm/objects/2026-03/leads/batch/update` | `hubspot api leads-batch-update` | write | contract | generated | Update a batch of leads by internal ID, or unique property values | +| `post-/crm/objects/2026-03/leads/batch/upsert_upsert` | `POST /crm/objects/2026-03/leads/batch/upsert` | `hubspot api leads-batch-upsert` | write | contract | generated | Create or update a batch of leads by unique property values | +| `post-/crm/objects/2026-03/leads/search_doSearch` | `POST /crm/objects/2026-03/leads/search` | `hubspot api leads-search` | read | contract | generated | Search for leads using specified criteria. | +| `get-/crm/objects/2026-03/leads/{leadsId}_getById` | `GET /crm/objects/2026-03/leads/{leadsId}` | `hubspot api leads-get` | read | — | generated | Read | +| `patch-/crm/objects/2026-03/leads/{leadsId}_update` | `PATCH /crm/objects/2026-03/leads/{leadsId}` | `hubspot api leads-update` | write | contract | generated | Update | +| `delete-/crm/objects/2026-03/leads/{leadsId}_archive` | `DELETE /crm/objects/2026-03/leads/{leadsId}` | `hubspot api leads-delete` | destructive | — | generated | Archive | +| `get-/crm/objects/2026-03/notes_getPage` | `GET /crm/objects/2026-03/notes` | `hubspot api notes-list` | read | — | generated | List | +| `post-/crm/objects/2026-03/notes_create` | `POST /crm/objects/2026-03/notes` | `hubspot api notes-create` | write | contract | generated | Create | +| `post-/crm/objects/2026-03/notes/batch/archive_archive` | `POST /crm/objects/2026-03/notes/batch/archive` | `hubspot api notes-batch-archive` | destructive | contract | generated | Archive a batch of notes by ID | +| `post-/crm/objects/2026-03/notes/batch/create_create` | `POST /crm/objects/2026-03/notes/batch/create` | `hubspot api notes-batch-create` | write | contract | generated | Create a batch of notes | +| `post-/crm/objects/2026-03/notes/batch/read_read` | `POST /crm/objects/2026-03/notes/batch/read` | `hubspot api notes-batch-read` | write | contract | generated | Read a batch of notes by internal ID, or unique property values | +| `post-/crm/objects/2026-03/notes/batch/update_update` | `POST /crm/objects/2026-03/notes/batch/update` | `hubspot api notes-batch-update` | write | contract | generated | Update a batch of notes by internal ID, or unique property values | +| `post-/crm/objects/2026-03/notes/batch/upsert_upsert` | `POST /crm/objects/2026-03/notes/batch/upsert` | `hubspot api notes-batch-upsert` | write | contract | generated | Create or update a batch of notes by unique property values | +| `post-/crm/objects/2026-03/notes/search_doSearch` | `POST /crm/objects/2026-03/notes/search` | `hubspot api notes-search` | read | contract | generated | Search for notes based on specified criteria. | +| `get-/crm/objects/2026-03/notes/{noteId}_getById` | `GET /crm/objects/2026-03/notes/{noteId}` | `hubspot api notes-get` | read | — | generated | Read | +| `patch-/crm/objects/2026-03/notes/{noteId}_update` | `PATCH /crm/objects/2026-03/notes/{noteId}` | `hubspot api notes-update` | write | contract | generated | Update | +| `delete-/crm/objects/2026-03/notes/{noteId}_archive` | `DELETE /crm/objects/2026-03/notes/{noteId}` | `hubspot api notes-delete` | destructive | — | generated | Archive | +| `get-/crm/objects/2026-03/calls_getPage` | `GET /crm/objects/2026-03/calls` | `hubspot api calls-list` | read | — | generated | List | +| `post-/crm/objects/2026-03/calls_create` | `POST /crm/objects/2026-03/calls` | `hubspot api calls-create` | write | contract | generated | Create | +| `post-/crm/objects/2026-03/calls/batch/archive_archive` | `POST /crm/objects/2026-03/calls/batch/archive` | `hubspot api calls-batch-archive` | destructive | contract | generated | Archive a batch of calls by ID | +| `post-/crm/objects/2026-03/calls/batch/create_create` | `POST /crm/objects/2026-03/calls/batch/create` | `hubspot api calls-batch-create` | write | contract | generated | Create a batch of calls | +| `post-/crm/objects/2026-03/calls/batch/read_read` | `POST /crm/objects/2026-03/calls/batch/read` | `hubspot api calls-batch-read` | write | contract | generated | Read a batch of calls by internal ID, or unique property values | +| `post-/crm/objects/2026-03/calls/batch/update_update` | `POST /crm/objects/2026-03/calls/batch/update` | `hubspot api calls-batch-update` | write | contract | generated | Update a batch of calls by internal ID, or unique property values | +| `post-/crm/objects/2026-03/calls/batch/upsert_upsert` | `POST /crm/objects/2026-03/calls/batch/upsert` | `hubspot api calls-batch-upsert` | write | contract | generated | Create or update a batch of calls by unique property values | +| `post-/crm/objects/2026-03/calls/search_doSearch` | `POST /crm/objects/2026-03/calls/search` | `hubspot api calls-search` | read | contract | generated | Search for calls | +| `get-/crm/objects/2026-03/calls/{callId}_getById` | `GET /crm/objects/2026-03/calls/{callId}` | `hubspot api calls-get` | read | — | generated | Read | +| `patch-/crm/objects/2026-03/calls/{callId}_update` | `PATCH /crm/objects/2026-03/calls/{callId}` | `hubspot api calls-update` | write | contract | generated | Update | +| `delete-/crm/objects/2026-03/calls/{callId}_archive` | `DELETE /crm/objects/2026-03/calls/{callId}` | `hubspot api calls-delete` | destructive | — | generated | Archive | +| `get-/crm/objects/2026-03/emails_getPage` | `GET /crm/objects/2026-03/emails` | `hubspot api emails-list` | read | — | generated | List | +| `post-/crm/objects/2026-03/emails_create` | `POST /crm/objects/2026-03/emails` | `hubspot api emails-create` | write | contract | generated | Create | +| `post-/crm/objects/2026-03/emails/batch/archive_archive` | `POST /crm/objects/2026-03/emails/batch/archive` | `hubspot api emails-batch-archive` | destructive | contract | generated | Archive a batch of emails by ID | +| `post-/crm/objects/2026-03/emails/batch/create_create` | `POST /crm/objects/2026-03/emails/batch/create` | `hubspot api emails-batch-create` | write | contract | generated | Create a batch of emails | +| `post-/crm/objects/2026-03/emails/batch/read_read` | `POST /crm/objects/2026-03/emails/batch/read` | `hubspot api emails-batch-read` | write | contract | generated | Read a batch of emails by internal ID, or unique property values | +| `post-/crm/objects/2026-03/emails/batch/update_update` | `POST /crm/objects/2026-03/emails/batch/update` | `hubspot api emails-batch-update` | write | contract | generated | Update a batch of emails by internal ID, or unique property values | +| `post-/crm/objects/2026-03/emails/batch/upsert_upsert` | `POST /crm/objects/2026-03/emails/batch/upsert` | `hubspot api emails-batch-upsert` | write | contract | generated | Create or update a batch of emails by unique property values | +| `post-/crm/objects/2026-03/emails/search_doSearch` | `POST /crm/objects/2026-03/emails/search` | `hubspot api emails-search` | read | contract | generated | Search for emails using specified criteria and filters. | +| `get-/crm/objects/2026-03/emails/{emailId}_getById` | `GET /crm/objects/2026-03/emails/{emailId}` | `hubspot api emails-get` | read | — | generated | Read | +| `patch-/crm/objects/2026-03/emails/{emailId}_update` | `PATCH /crm/objects/2026-03/emails/{emailId}` | `hubspot api emails-update` | write | contract | generated | Update | +| `delete-/crm/objects/2026-03/emails/{emailId}_archive` | `DELETE /crm/objects/2026-03/emails/{emailId}` | `hubspot api emails-delete` | destructive | — | generated | Archive | +| `get-/crm/objects/2026-03/meetings_getPage` | `GET /crm/objects/2026-03/meetings` | `hubspot api meetings-list` | read | — | generated | List | +| `post-/crm/objects/2026-03/meetings_create` | `POST /crm/objects/2026-03/meetings` | `hubspot api meetings-create` | write | contract | generated | Create | +| `post-/crm/objects/2026-03/meetings/batch/archive_archive` | `POST /crm/objects/2026-03/meetings/batch/archive` | `hubspot api meetings-batch-archive` | destructive | contract | generated | Archive a batch of meetings by ID | +| `post-/crm/objects/2026-03/meetings/batch/create_create` | `POST /crm/objects/2026-03/meetings/batch/create` | `hubspot api meetings-batch-create` | write | contract | generated | Create a batch of meetings | +| `post-/crm/objects/2026-03/meetings/batch/read_read` | `POST /crm/objects/2026-03/meetings/batch/read` | `hubspot api meetings-batch-read` | write | contract | generated | Read a batch of meetings by internal ID, or unique property values | +| `post-/crm/objects/2026-03/meetings/batch/update_update` | `POST /crm/objects/2026-03/meetings/batch/update` | `hubspot api meetings-batch-update` | write | contract | generated | Update a batch of meetings by internal ID, or unique property values | +| `post-/crm/objects/2026-03/meetings/batch/upsert_upsert` | `POST /crm/objects/2026-03/meetings/batch/upsert` | `hubspot api meetings-batch-upsert` | write | contract | generated | Create or update a batch of meetings by unique property values | +| `post-/crm/objects/2026-03/meetings/search_doSearch` | `POST /crm/objects/2026-03/meetings/search` | `hubspot api meetings-search` | read | contract | generated | Search for meetings | +| `get-/crm/objects/2026-03/meetings/{meetingId}_getById` | `GET /crm/objects/2026-03/meetings/{meetingId}` | `hubspot api meetings-get` | read | — | generated | Read | +| `patch-/crm/objects/2026-03/meetings/{meetingId}_update` | `PATCH /crm/objects/2026-03/meetings/{meetingId}` | `hubspot api meetings-update` | write | contract | generated | Update | +| `delete-/crm/objects/2026-03/meetings/{meetingId}_archive` | `DELETE /crm/objects/2026-03/meetings/{meetingId}` | `hubspot api meetings-delete` | destructive | — | generated | Archive | +| `get-/crm/objects/2026-03/tasks_getPage` | `GET /crm/objects/2026-03/tasks` | `hubspot api tasks-list` | read | — | generated | List | +| `post-/crm/objects/2026-03/tasks_create` | `POST /crm/objects/2026-03/tasks` | `hubspot api tasks-create` | write | contract | generated | Create | +| `post-/crm/objects/2026-03/tasks/batch/archive_archive` | `POST /crm/objects/2026-03/tasks/batch/archive` | `hubspot api tasks-batch-archive` | destructive | contract | generated | Archive a batch of tasks by ID | +| `post-/crm/objects/2026-03/tasks/batch/create_create` | `POST /crm/objects/2026-03/tasks/batch/create` | `hubspot api tasks-batch-create` | write | contract | generated | Create a batch of tasks | +| `post-/crm/objects/2026-03/tasks/batch/read_read` | `POST /crm/objects/2026-03/tasks/batch/read` | `hubspot api tasks-batch-read` | write | contract | generated | Read a batch of tasks by internal ID, or unique property values | +| `post-/crm/objects/2026-03/tasks/batch/update_update` | `POST /crm/objects/2026-03/tasks/batch/update` | `hubspot api tasks-batch-update` | write | contract | generated | Update a batch of tasks by internal ID, or unique property values | +| `post-/crm/objects/2026-03/tasks/batch/upsert_upsert` | `POST /crm/objects/2026-03/tasks/batch/upsert` | `hubspot api tasks-batch-upsert` | write | contract | generated | Create or update a batch of tasks by unique property values | +| `post-/crm/objects/2026-03/tasks/search_doSearch` | `POST /crm/objects/2026-03/tasks/search` | `hubspot api tasks-search` | read | contract | generated | Search for tasks using specified criteria. | +| `get-/crm/objects/2026-03/tasks/{taskId}_getById` | `GET /crm/objects/2026-03/tasks/{taskId}` | `hubspot api tasks-get` | read | — | generated | Read | +| `patch-/crm/objects/2026-03/tasks/{taskId}_update` | `PATCH /crm/objects/2026-03/tasks/{taskId}` | `hubspot api tasks-update` | write | contract | generated | Update | +| `delete-/crm/objects/2026-03/tasks/{taskId}_archive` | `DELETE /crm/objects/2026-03/tasks/{taskId}` | `hubspot api tasks-delete` | destructive | — | generated | Archive | +| `get-/crm/owners/2026-03_/crm/owners/v3` | `GET /crm/owners/2026-03` | `hubspot api owners-list` | read | — | generated | List owners | +| `get-/crm/owners/2026-03/{ownerId}_getById` | `GET /crm/owners/2026-03/{ownerId}` | `hubspot api owners-get` | read | — | generated | Retrieve a specific owner by ID | +| `get-/crm/pipelines/2026-03/{objectType}_getAll` | `GET /crm/pipelines/2026-03/{objectType}` | `hubspot api pipelines-list` | read | — | generated | Retrieve all pipelines | +| `post-/crm/pipelines/2026-03/{objectType}_create` | `POST /crm/pipelines/2026-03/{objectType}` | `hubspot api pipelines-create` | write | contract | generated | Create a pipeline | +| `get-/crm/pipelines/2026-03/{objectType}/{pipelineId}_getById` | `GET /crm/pipelines/2026-03/{objectType}/{pipelineId}` | `hubspot api pipelines-get` | read | — | generated | Return a pipeline by ID | +| `put-/crm/pipelines/2026-03/{objectType}/{pipelineId}_replace` | `PUT /crm/pipelines/2026-03/{objectType}/{pipelineId}` | `hubspot api pipelines-replace` | write | contract | generated | Replace a pipeline | +| `patch-/crm/pipelines/2026-03/{objectType}/{pipelineId}_update` | `PATCH /crm/pipelines/2026-03/{objectType}/{pipelineId}` | `hubspot api pipelines-update` | write | contract | generated | Perform a partial update of the pipeline identified by pipelineId. | +| `delete-/crm/pipelines/2026-03/{objectType}/{pipelineId}_archive` | `DELETE /crm/pipelines/2026-03/{objectType}/{pipelineId}` | `hubspot api pipelines-delete` | destructive | — | generated | Delete a pipeline | +| `get-/crm/pipelines/2026-03/{objectType}/{pipelineId}/audit_getAudit` | `GET /crm/pipelines/2026-03/{objectType}/{pipelineId}/audit` | `hubspot api pipelines-audit-list` | read | — | generated | Return an audit of all changes to the pipeline | +| `get-/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages_getAll` | `GET /crm/pipelines/2026-03/{objectType}/{pipelineId}/stages` | `hubspot api pipelines-stages-list` | read | — | generated | Return all stages of a pipeline | +| `post-/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages_create` | `POST /crm/pipelines/2026-03/{objectType}/{pipelineId}/stages` | `hubspot api pipelines-stages-create` | write | contract | generated | Create a pipeline stage | +| `get-/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}_getById` | `GET /crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}` | `hubspot api pipelines-stages-get` | read | — | generated | Return a pipeline stage by ID | +| `put-/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}_replace` | `PUT /crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}` | `hubspot api pipelines-stages-replace` | write | contract | generated | Replace a pipeline stage | +| `patch-/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}_update` | `PATCH /crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}` | `hubspot api pipelines-stages-update` | write | contract | generated | Update specific properties of an existing pipeline stage. | +| `delete-/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}_archive` | `DELETE /crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}` | `hubspot api pipelines-stages-delete` | destructive | — | generated | Delete a pipeline stage | +| `get-/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}/audit_getAudit` | `GET /crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}/audit` | `hubspot api pipelines-stages-audit-list` | read | — | generated | Retrieve a reverse chronological list of all changes made to a specific pipeline stage. | +| `get-/crm/properties/2026-03/{objectType}_/crm/properties/2025-09/{objectType}` | `GET /crm/properties/2026-03/{objectType}` | `hubspot api properties-list` | read | — | generated | Read all properties | +| `post-/crm/properties/2026-03/{objectType}_/crm/properties/2025-09/{objectType}` | `POST /crm/properties/2026-03/{objectType}` | `hubspot api properties-create` | write | contract | generated | Create a property | +| `post-/crm/properties/2026-03/{objectType}/batch/archive_/crm/properties/2025-09/{objectType}/batch/archive` | `POST /crm/properties/2026-03/{objectType}/batch/archive` | `hubspot api properties-batch-archive` | destructive | contract | generated | Archive a batch of properties | +| `post-/crm/properties/2026-03/{objectType}/batch/create_/crm/properties/2025-09/{objectType}/batch/create` | `POST /crm/properties/2026-03/{objectType}/batch/create` | `hubspot api properties-batch-create` | write | contract | generated | Create a batch of properties | +| `post-/crm/properties/2026-03/{objectType}/batch/read_/crm/properties/2025-09/{objectType}/batch/read` | `POST /crm/properties/2026-03/{objectType}/batch/read` | `hubspot api properties-batch-read` | write | contract | generated | Read a batch of properties | +| `get-/crm/properties/2026-03/{objectType}/groups_/crm/properties/2025-09/{objectType}/groups` | `GET /crm/properties/2026-03/{objectType}/groups` | `hubspot api properties-groups-list` | read | — | generated | Read all property groups | +| `post-/crm/properties/2026-03/{objectType}/groups_/crm/properties/2025-09/{objectType}/groups` | `POST /crm/properties/2026-03/{objectType}/groups` | `hubspot api properties-groups-create` | write | contract | generated | Create a property group | +| `get-/crm/properties/2026-03/{objectType}/groups/{groupName}_/crm/properties/2025-09/{objectType}/groups/{groupName}` | `GET /crm/properties/2026-03/{objectType}/groups/{groupName}` | `hubspot api properties-groups-get` | read | — | generated | Read a property group | +| `patch-/crm/properties/2026-03/{objectType}/groups/{groupName}_/crm/properties/2025-09/{objectType}/groups/{groupName}` | `PATCH /crm/properties/2026-03/{objectType}/groups/{groupName}` | `hubspot api properties-groups-update` | write | contract | generated | Update a property group | +| `delete-/crm/properties/2026-03/{objectType}/groups/{groupName}_/crm/properties/2025-09/{objectType}/groups/{groupName}` | `DELETE /crm/properties/2026-03/{objectType}/groups/{groupName}` | `hubspot api properties-groups-delete` | destructive | — | generated | Archive a property group | +| `get-/crm/properties/2026-03/{objectType}/{propertyName}_/crm/properties/2025-09/{objectType}/{propertyName}` | `GET /crm/properties/2026-03/{objectType}/{propertyName}` | `hubspot api properties-get` | read | — | generated | Read a property | +| `patch-/crm/properties/2026-03/{objectType}/{propertyName}_/crm/properties/2025-09/{objectType}/{propertyName}` | `PATCH /crm/properties/2026-03/{objectType}/{propertyName}` | `hubspot api properties-update` | write | contract | generated | Update a property | +| `delete-/crm/properties/2026-03/{objectType}/{propertyName}_/crm/properties/2025-09/{objectType}/{propertyName}` | `DELETE /crm/properties/2026-03/{objectType}/{propertyName}` | `hubspot api properties-delete` | destructive | — | generated | Archive a property | +| `post-/crm/associations/2026-03/usage/high-usage-report/{userId}_/crm/associations/2025-09/usage/high-usage-report/{userId}` | `POST /crm/associations/2026-03/usage/high-usage-report/{userId}` | `hubspot api associations-usage-high-usage-report-update` | write | — | generated | Report high usage | +| `post-/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/archive_/crm/associations/2025-09/{fromObjectType}/{toObjectType}/batch/archive` | `POST /crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/archive` | `hubspot api associations-batch-archive` | destructive | contract | generated | Remove associations | +| `post-/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/associate/default_/crm/associations/2025-09/{fromObjectType}/{toObjectType}/batch/associate/default` | `POST /crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/associate/default` | `hubspot api associations-batch-associate-default` | write | contract | generated | Create Default Associations | +| `post-/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/create_/crm/associations/2025-09/{fromObjectType}/{toObjectType}/batch/create` | `POST /crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/create` | `hubspot api associations-batch-create` | write | contract | generated | Associate records (labelled) | +| `post-/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/labels/archive_/crm/associations/2025-09/{fromObjectType}/{toObjectType}/batch/labels/archive` | `POST /crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/labels/archive` | `hubspot api associations-batch-labels-archive` | destructive | contract | generated | Delete Specific Labels | +| `post-/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/read_/crm/associations/2025-09/{fromObjectType}/{toObjectType}/batch/read` | `POST /crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/read` | `hubspot api associations-batch-read` | write | contract | generated | Retrieve associations | +| `post-/crm/objects/2026-03/{objectType}/search_/crm/objects/2025-09/{objectType}/search` | `POST /crm/objects/2026-03/{objectType}/search` | `hubspot api search` | read | contract | generated | | +| `get-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}_/crm/objects/2025-09/{objectType}/{objectId}/associations/{toObjectType}` | `GET /crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}` | `hubspot api associations-get` | read | — | generated | Retrieve all associations by object type | +| `get-/account-info/2026-03/api-usage/daily/private-apps_/account-info/2025-09/api-usage/daily/private-apps` | `GET /account-info/2026-03/api-usage/daily/private-apps` | `hubspot api account-info-api-usage-daily-private-apps-list` | read | — | generated | Retrieve private app daily API usage | +| `get-/account-info/2026-03/details_/account-info/2025-09/details` | `GET /account-info/2026-03/details` | `hubspot api account-info-details-list` | read | — | generated | Retrieve account details | + +## Effects not taken from the HTTP method + +| Operation | Effect | Why | +|---|---|---| +| `post-/crm/objects/2026-03/contacts/batch/archive_archive` | destructive | override: a POST that archives, erases or merges away records | +| `post-/crm/objects/2026-03/contacts/gdpr-delete_purge` | destructive | override: a POST that archives, erases or merges away records | +| `post-/crm/objects/2026-03/contacts/merge_merge` | destructive | override: a POST that archives, erases or merges away records | +| `post-/crm/objects/2026-03/contacts/search_doSearch` | read | a POST to a …/search or …/query path only reads (readingPosts rule) | +| `post-/crm/objects/2026-03/companies/batch/archive_archive` | destructive | override: a POST that archives, erases or merges away records | +| `post-/crm/objects/2026-03/companies/merge_merge` | destructive | override: a POST that archives, erases or merges away records | +| `post-/crm/objects/2026-03/companies/search_doSearch` | read | a POST to a …/search or …/query path only reads (readingPosts rule) | +| `post-/crm/objects/2026-03/0-3/batch/archive_archive` | destructive | override: a POST that archives, erases or merges away records | +| `post-/crm/objects/2026-03/0-3/merge_merge` | destructive | override: a POST that archives, erases or merges away records | +| `post-/crm/objects/2026-03/0-3/search_doSearch` | read | a POST to a …/search or …/query path only reads (readingPosts rule) | +| `post-/crm/objects/2026-03/tickets/batch/archive_archive` | destructive | override: a POST that archives, erases or merges away records | +| `post-/crm/objects/2026-03/tickets/merge_merge` | destructive | override: a POST that archives, erases or merges away records | +| `post-/crm/objects/2026-03/tickets/search_doSearch` | read | a POST to a …/search or …/query path only reads (readingPosts rule) | +| `post-/crm/objects/2026-03/leads/batch/archive_archive` | destructive | override: a POST that archives, erases or merges away records | +| `post-/crm/objects/2026-03/leads/search_doSearch` | read | a POST to a …/search or …/query path only reads (readingPosts rule) | +| `post-/crm/objects/2026-03/notes/batch/archive_archive` | destructive | override: a POST that archives, erases or merges away records | +| `post-/crm/objects/2026-03/notes/search_doSearch` | read | a POST to a …/search or …/query path only reads (readingPosts rule) | +| `post-/crm/objects/2026-03/calls/batch/archive_archive` | destructive | override: a POST that archives, erases or merges away records | +| `post-/crm/objects/2026-03/calls/search_doSearch` | read | a POST to a …/search or …/query path only reads (readingPosts rule) | +| `post-/crm/objects/2026-03/emails/batch/archive_archive` | destructive | override: a POST that archives, erases or merges away records | +| `post-/crm/objects/2026-03/emails/search_doSearch` | read | a POST to a …/search or …/query path only reads (readingPosts rule) | +| `post-/crm/objects/2026-03/meetings/batch/archive_archive` | destructive | override: a POST that archives, erases or merges away records | +| `post-/crm/objects/2026-03/meetings/search_doSearch` | read | a POST to a …/search or …/query path only reads (readingPosts rule) | +| `post-/crm/objects/2026-03/tasks/batch/archive_archive` | destructive | override: a POST that archives, erases or merges away records | +| `post-/crm/objects/2026-03/tasks/search_doSearch` | read | a POST to a …/search or …/query path only reads (readingPosts rule) | +| `post-/crm/properties/2026-03/{objectType}/batch/archive_/crm/properties/2025-09/{objectType}/batch/archive` | destructive | override: a POST that archives, erases or merges away records | +| `post-/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/archive_/crm/associations/2025-09/{fromObjectType}/{toObjectType}/batch/archive` | destructive | override: a POST that archives, erases or merges away records | +| `post-/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/labels/archive_/crm/associations/2025-09/{fromObjectType}/{toObjectType}/batch/labels/archive` | destructive | override: a POST that archives, erases or merges away records | +| `post-/crm/objects/2026-03/{objectType}/search_/crm/objects/2025-09/{objectType}/search` | read | a POST to a …/search or …/query path only reads (readingPosts rule) | ## Pagination | Operation | Style | Request | Answer | Source | |---|---|---|---|---| -| `listComments` | cursor | query `start_cursor`, query `limit` | next `next_cursor`, items `results`, more `has_more` | detected | +| `get-/crm/objects/2026-03/contacts_getPage` | cursor | query `after`, query `limit` | next `paging.next.after`, items `results` | detected | +| `post-/crm/objects/2026-03/contacts/search_doSearch` | cursor | body `after`, body `limit` | next `paging.next.after`, items `results` | detected | +| `get-/crm/objects/2026-03/companies_getPage` | cursor | query `after`, query `limit` | next `paging.next.after`, items `results` | detected | +| `post-/crm/objects/2026-03/companies/search_doSearch` | cursor | body `after`, body `limit` | next `paging.next.after`, items `results` | detected | +| `get-/crm/objects/2026-03/0-3_getPage` | cursor | query `after`, query `limit` | next `paging.next.after`, items `results` | detected | +| `post-/crm/objects/2026-03/0-3/search_doSearch` | cursor | body `after`, body `limit` | next `paging.next.after`, items `results` | detected | +| `get-/crm/objects/2026-03/tickets_getPage` | cursor | query `after`, query `limit` | next `paging.next.after`, items `results` | detected | +| `post-/crm/objects/2026-03/tickets/search_doSearch` | cursor | body `after`, body `limit` | next `paging.next.after`, items `results` | detected | +| `get-/crm/objects/2026-03/leads_getPage` | cursor | query `after`, query `limit` | next `paging.next.after`, items `results` | detected | +| `post-/crm/objects/2026-03/leads/search_doSearch` | cursor | body `after`, body `limit` | next `paging.next.after`, items `results` | detected | +| `get-/crm/objects/2026-03/notes_getPage` | cursor | query `after`, query `limit` | next `paging.next.after`, items `results` | detected | +| `post-/crm/objects/2026-03/notes/search_doSearch` | cursor | body `after`, body `limit` | next `paging.next.after`, items `results` | detected | +| `get-/crm/objects/2026-03/calls_getPage` | cursor | query `after`, query `limit` | next `paging.next.after`, items `results` | detected | +| `post-/crm/objects/2026-03/calls/search_doSearch` | cursor | body `after`, body `limit` | next `paging.next.after`, items `results` | detected | +| `get-/crm/objects/2026-03/emails_getPage` | cursor | query `after`, query `limit` | next `paging.next.after`, items `results` | detected | +| `post-/crm/objects/2026-03/emails/search_doSearch` | cursor | body `after`, body `limit` | next `paging.next.after`, items `results` | detected | +| `get-/crm/objects/2026-03/meetings_getPage` | cursor | query `after`, query `limit` | next `paging.next.after`, items `results` | detected | +| `post-/crm/objects/2026-03/meetings/search_doSearch` | cursor | body `after`, body `limit` | next `paging.next.after`, items `results` | detected | +| `get-/crm/objects/2026-03/tasks_getPage` | cursor | query `after`, query `limit` | next `paging.next.after`, items `results` | detected | +| `post-/crm/objects/2026-03/tasks/search_doSearch` | cursor | body `after`, body `limit` | next `paging.next.after`, items `results` | detected | +| `get-/crm/owners/2026-03_/crm/owners/v3` | cursor | query `after`, query `limit` | next `paging.next.after`, items `results` | detected | +| `post-/crm/objects/2026-03/{objectType}/search_/crm/objects/2025-09/{objectType}/search` | cursor | body `after`, body `limit` | next `paging.next.after`, items `results` | detected | +| `get-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}_/crm/objects/2025-09/{objectType}/{objectId}/associations/{toObjectType}` | cursor | query `after`, query `limit` | next `paging.next.after`, items `results` | detected | + +## Sign-in + +Not from the source: a private app token or service key goes in Authorization: Bearer; the specs list only OAuth and the retired hapikey ## Permission keys | Operation | Key | When | |---|---|---| -| `deleteComment` | `comments.delete` | always | +| `post-/crm/objects/2026-03/contacts/batch/archive_archive` | `people.delete` | always | +| `post-/crm/objects/2026-03/contacts/gdpr-delete_purge` | `people.delete` | always | +| `post-/crm/objects/2026-03/contacts/merge_merge` | `people.delete` | always | +| `delete-/crm/objects/2026-03/contacts/{contactId}_archive` | `people.delete` | always | +| `delete-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}` | `associations.delete` | always | +| `post-/crm/objects/2026-03/companies/batch/archive_archive` | `organizations.delete` | always | +| `post-/crm/objects/2026-03/companies/merge_merge` | `organizations.delete` | always | +| `delete-/crm/objects/2026-03/companies/{companyId}_archive` | `organizations.delete` | always | +| `post-/crm/objects/2026-03/0-3/batch/archive_archive` | `deals.delete` | always | +| `post-/crm/objects/2026-03/0-3/merge_merge` | `deals.delete` | always | +| `delete-/crm/objects/2026-03/0-3/{dealId}_archive` | `deals.delete` | always | +| `post-/crm/objects/2026-03/tickets/batch/archive_archive` | `tickets.delete` | always | +| `post-/crm/objects/2026-03/tickets/merge_merge` | `tickets.delete` | always | +| `delete-/crm/objects/2026-03/tickets/{ticketId}_archive` | `tickets.delete` | always | +| `post-/crm/objects/2026-03/leads/batch/archive_archive` | `leads.delete` | always | +| `delete-/crm/objects/2026-03/leads/{leadsId}_archive` | `leads.delete` | always | +| `post-/crm/objects/2026-03/notes/batch/archive_archive` | `notes.delete` | always | +| `delete-/crm/objects/2026-03/notes/{noteId}_archive` | `notes.delete` | always | +| `post-/crm/objects/2026-03/calls/batch/archive_archive` | `calls.delete` | always | +| `delete-/crm/objects/2026-03/calls/{callId}_archive` | `calls.delete` | always | +| `post-/crm/objects/2026-03/emails/batch/archive_archive` | `emails.delete` | always | +| `delete-/crm/objects/2026-03/emails/{emailId}_archive` | `emails.delete` | always | +| `post-/crm/objects/2026-03/meetings/batch/archive_archive` | `meetings.delete` | always | +| `delete-/crm/objects/2026-03/meetings/{meetingId}_archive` | `meetings.delete` | always | +| `post-/crm/objects/2026-03/tasks/batch/archive_archive` | `tasks.delete` | always | +| `delete-/crm/objects/2026-03/tasks/{taskId}_archive` | `tasks.delete` | always | +| `delete-/crm/pipelines/2026-03/{objectType}/{pipelineId}_archive` | `pipelines.delete` | always | +| `delete-/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}_archive` | `pipelines.delete` | always | +| `post-/crm/properties/2026-03/{objectType}/batch/archive_/crm/properties/2025-09/{objectType}/batch/archive` | `fields.delete` | always | +| `delete-/crm/properties/2026-03/{objectType}/groups/{groupName}_/crm/properties/2025-09/{objectType}/groups/{groupName}` | `fields.delete` | always | +| `delete-/crm/properties/2026-03/{objectType}/{propertyName}_/crm/properties/2025-09/{objectType}/{propertyName}` | `fields.delete` | always | +| `post-/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/archive_/crm/associations/2025-09/{fromObjectType}/{toObjectType}/batch/archive` | `associations.delete` | always | +| `post-/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/labels/archive_/crm/associations/2025-09/{fromObjectType}/{toObjectType}/batch/labels/archive` | `associations.delete` | always | + +## Spec corrections + +- patched associations /paths/~1crm~1objects~12026-03~1{fromObjectType}~1{fromObjectId}~1associations~1default~1{toObjectType}~1{toObjectId}/put/operationId: the same operation as in each object spec, whose id names the 2026-03 path, not 2025-09 +- patched associations /paths/~1crm~1objects~12026-03~1{objectType}~1{objectId}~1associations~1{toObjectType}~1{toObjectId}/put/operationId: the same operation as in each object spec, whose id names the 2026-03 path, not 2025-09 +- patched associations /paths/~1crm~1objects~12026-03~1{objectType}~1{objectId}~1associations~1{toObjectType}~1{toObjectId}/delete/operationId: the same operation as in each object spec, whose id names the 2026-03 path, not 2025-09 +- merged: schemas/AssociatedId +- merged: schemas/AssociationSpec +- merged: schemas/BatchInputSimplePublicObjectBatchInput +- merged: schemas/BatchInputSimplePublicObjectBatchInputForCreate +- merged: schemas/BatchInputSimplePublicObjectBatchInputUpsert +- merged: schemas/BatchInputSimplePublicObjectId +- merged: schemas/BatchReadInputSimplePublicObjectId +- merged: schemas/BatchResponsePublicDefaultAssociation +- merged: schemas/BatchResponseSimplePublicObject +- merged: schemas/BatchResponseSimplePublicObjectWithErrors +- merged: schemas/BatchResponseSimplePublicUpsertObject +- merged: schemas/BatchResponseSimplePublicUpsertObjectWithErrors +- merged: schemas/CollectionResponseAssociatedId +- merged: schemas/CollectionResponseSimplePublicObjectWithAssociationsForwardPaging +- merged: schemas/CollectionResponseWithTotalSimplePublicObject +- merged: schemas/Error +- merged: schemas/ErrorDetail +- merged: schemas/Filter +- merged: schemas/FilterGroup +- merged: schemas/ForwardPaging +- merged: schemas/LabelsBetweenObjectPair +- merged: schemas/NextPage +- merged: schemas/Paging +- merged: schemas/PreviousPage +- merged: schemas/PublicAssociationsForObject +- merged: schemas/PublicDefaultAssociation +- merged: schemas/PublicMergeInput +- merged: schemas/PublicObjectId +- merged: schemas/PublicObjectSearchRequest +- merged: schemas/PublicObjectWarning +- merged: schemas/SimplePublicObject +- merged: schemas/SimplePublicObjectBatchInput +- merged: schemas/SimplePublicObjectBatchInputForCreate +- merged: schemas/SimplePublicObjectBatchInputUpsert +- merged: schemas/SimplePublicObjectId +- merged: schemas/SimplePublicObjectInput +- merged: schemas/SimplePublicObjectInputForCreate +- merged: schemas/SimplePublicObjectWithAssociations +- merged: schemas/SimplePublicUpsertObject +- merged: schemas/StandardError +- merged: schemas/ValueWithTimestamp +- merged: responses/Error +- merged: schemas/BatchResponsePublicDefaultAssociation → AssociationsBatchResponsePublicDefaultAssociation (associations) diff --git a/docs/dev/TESTING.md b/docs/dev/TESTING.md index 170d257..b0e1c1b 100644 --- a/docs/dev/TESTING.md +++ b/docs/dev/TESTING.md @@ -8,7 +8,7 @@ How the tests run, and what they never touch. The rules are the handbook's folder. `src/testing/sandbox.ts` names the config folder, which tests write into by name. - `pnpm test:coverage` adds the coverage floor in `vitest.config.ts`. - A script that starts the built bin runs it through `scripts/sandboxed.ts`, as `lint:commands` and the smoke tests - do: a temporary home folder, its `XDG_*` folders, no `HUBSPOT_*` overrides and the keyring out of reach. A run + do: a temporary home folder, its `XDG_*` folders, no `WCHUBSPOT_*` overrides and the keyring out of reach. A run that sees your home can move your real folders. - `pnpm test:slow` lists the 20 slowest tests and the 10 slowest files. No test waits for real time (`WC-TEST-5`): waits go through an injected sleep, and `fakeClock()` from `@wirecat/cli-base/testing` records them. diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index e67c2cc..0b743d2 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -7,9 +7,9 @@ support request. | --- | --- | | Not sure what is set up | Run `hubspot doctor`. It reads no keyring and uses no network. | | `hubspot` is not found | Open a new terminal, and check that npm's global folder is on `PATH`. | -| "name a profile" | Put the profile first, as in `hubspot personal config show`, or set `HUBSPOT_PROFILE`. | +| "name a profile" | Put the profile first, as in `hubspot personal config show`, or set `WCHUBSPOT_PROFILE`. | | The settings file does not read | `doctor` lists every problem in the file under `config.issues`. Run the `config unset` each one gives, or fix the file by hand. | | `doctor` lists `files.problems` | Other users of the computer can read `config.json` or enter its folder. Run each `chmod` that `doctor` prints after "to make it private:". `doctor` never changes a file mode itself. | -| A write is refused | The profile's permissions or `HUBSPOT_READ_ONLY` stop it; see [settings](configuration.md#permissions). | +| A write is refused | The profile's permissions or `WCHUBSPOT_READ_ONLY` stop it; see [settings](configuration.md#permissions). | Never paste a token, a password or private content into a support request. diff --git a/docs/usage.md b/docs/usage.md index 5ce372b..a89696d 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -10,7 +10,7 @@ A profile is a name you choose for one account. It is the first word of every co hubspot personal config show ``` -`HUBSPOT_PROFILE=personal` does the same for one shell session. No profile is ever assumed, not even the only one: a +`WCHUBSPOT_PROFILE=personal` does the same for one shell session. No profile is ever assumed, not even the only one: a command without one stops with exit code 2 and lists the profiles on this computer. ## Output for scripts diff --git a/scripts/generate.ts b/scripts/generate.ts index 5b02ec1..0f59da4 100644 --- a/scripts/generate.ts +++ b/scripts/generate.ts @@ -13,8 +13,50 @@ import { specModel } from "./spec-model.ts" // The service's API description → src/generated/ and docs/dev/API_COVERAGE.md. Each correction below is read from // the service's documentation, never guessed; cli-base docs/standards/kit-surface.md says what each one does. +const P = "/crm/pipelines/2026-03/{objectType}" +const R = "/crm/properties/2026-03/{objectType}" +const R_OLD = "/crm/properties/2025-09/{objectType}" +/** A list and a read of one both end in a path parameter here, so the path alone names them alike. */ +const COMMANDS: Record = { + [`get-${P}_getAll`]: "pipelines-list", + [`get-${P}/{pipelineId}_getById`]: "pipelines-get", + [`post-${P}_create`]: "pipelines-create", + [`patch-${P}/{pipelineId}_update`]: "pipelines-update", + [`get-${R}_${R_OLD}`]: "properties-list", + [`get-${R}/{propertyName}_${R_OLD}/{propertyName}`]: "properties-get", + [`post-${R}_${R_OLD}`]: "properties-create", + [`patch-${R}/{propertyName}_${R_OLD}/{propertyName}`]: "properties-update", +} + +/** + * POSTs that delete: `batch/archive` and `labels/archive` archive records or labels, `gdpr-delete` erases a contact + * for good, and `merge` keeps one of two records (HubSpot's "Using object APIs" and "Merge records" guides). + */ +const DELETING_POST = /\/(batch\/archive|batch\/labels\/archive|gdpr-delete|merge)$/ + +/** The words of cli-core's CRM commands, so `people.delete` denied there also holds in `api`. */ +const GROUPS: Record = { + contacts: "people", + companies: "organizations", + owners: "users", + properties: "fields", + "account-info": "account", +} +const groupOf = (command: string) => { + const first = command.startsWith("account-info") ? "account-info" : (command.split("-")[0] ?? command) + return GROUPS[first] ?? first +} + const root = resolve(import.meta.dirname, "..") const { model, notes } = await specModel(root) +const overrides = Object.fromEntries( + model.operations + .filter(({ binding }) => binding.kind === "http" && binding.method === "POST" && DELETING_POST.test(binding.path)) + .map(({ id }) => [ + id, + { effect: "destructive" as const, reason: "a POST that archives, erases or merges away records" }, + ]), +) const artifacts = generate( model, [ @@ -30,17 +72,17 @@ const artifacts = generate( ], { banner: ["Source: spec/hubspot/, checked against provenance.json", "Run: pnpm generate"], - // SAMPLE: operation id → { effect, reason } where the HTTP method misleads, as a POST that deletes. - overrides: {}, - // SAMPLE: true when the service's POST …/search and …/query only read. - readingPosts: false, - // SAMPLE: command names from the paths; map an operation whose name comes out wrong in `commands`. - names: { fromPath: true }, - // SAMPLE: the permission group, and the body fields or query parameters that delete when true. - permissions: { group: "comments", deletingFlags: [] }, - // SAMPLE: how each read pages, found from the spec; an override's `pagination` wins. `auth` replaces a wrong or - // missing sign-in in the spec: { securitySchemes, security, reason }. + overrides, + readingPosts: true, + names: { fromPath: true, segments: { crm: "", objects: "", "0-3": "deals" }, commands: COMMANDS }, + permissions: { group: (operation) => groupOf(operation.command ?? operation.id), deletingFlags: [] }, pagination: true, + auth: { + securitySchemes: { token: { type: "http", scheme: "bearer" } }, + security: [{ token: [] }], + reason: + "a private app token or service key goes in Authorization: Bearer; the specs list only OAuth and the retired hapikey", + }, }, ) const coverage = artifacts.find((artifact) => artifact.path === "docs/dev/API_COVERAGE.md") diff --git a/scripts/live.sh b/scripts/live.sh index 95402d5..5c396dd 100755 --- a/scripts/live.sh +++ b/scripts/live.sh @@ -12,10 +12,10 @@ root=$(cd -- "$(dirname -- "$0")/.." && pwd) work=$(mktemp -d) trap 'rm -rf "$work"' EXIT -export HUBSPOT_CONFIG_DIR="$work/config" HUBSPOT_STATE_DIR="$work/state" HUBSPOT_CACHE_DIR="$work/cache" +export WCHUBSPOT_CONFIG_DIR="$work/config" WCHUBSPOT_STATE_DIR="$work/state" WCHUBSPOT_CACHE_DIR="$work/cache" export MESSAGING_STORE="$work/wirecat.db" export DBUS_SESSION_BUS_ADDRESS="disabled:" -unset HUBSPOT_TOKEN +unset WCHUBSPOT_TOKEN cli=(node "$root/dist/bin/hubspot.js") pnpm --dir "$root" -s build >/dev/null diff --git a/scripts/sandboxed.ts b/scripts/sandboxed.ts index 473934a..8279321 100644 --- a/scripts/sandboxed.ts +++ b/scripts/sandboxed.ts @@ -11,7 +11,7 @@ if (!command) { process.exit(2) } const home = mkdtempSync(join(tmpdir(), "hubspot-sandbox-")) -const env = Object.fromEntries(Object.entries(process.env).filter(([name]) => !/^(XDG_|HUBSPOT_)/.test(name))) +const env = Object.fromEntries(Object.entries(process.env).filter(([name]) => !/^(XDG_|WCHUBSPOT_)/.test(name))) const run = spawnSync(command, args, { stdio: "inherit", shell: process.platform === "win32", @@ -27,7 +27,7 @@ const run = spawnSync(command, args, { XDG_CACHE_HOME: join(home, ".cache"), MESSAGING_STORE: join(home, "store.db"), WIRECAT_STATE_DIR: join(home, "wirecat"), - HUBSPOT_NO_UPDATE_CHECK: "1", + WCHUBSPOT_NO_UPDATE_CHECK: "1", // A throwaway HOME does not hide the keyring: D-Bus still reaches it. DBUS_SESSION_BUS_ADDRESS: "disabled:", }, diff --git a/scripts/smoke-bundle.ts b/scripts/smoke-bundle.ts index 2607553..4c9b3d7 100644 --- a/scripts/smoke-bundle.ts +++ b/scripts/smoke-bundle.ts @@ -11,7 +11,7 @@ import { tmpdir } from "node:os" import { join } from "node:path" const COMMAND = "hubspot" -const PREFIX = "HUBSPOT" +const PREFIX = "WCHUBSPOT" const runtime = "Bun" in globalThis ? "bun" : "node" const failures: string[] = [] diff --git a/scripts/smoke.ts b/scripts/smoke.ts index 11c35d8..bc629b3 100644 --- a/scripts/smoke.ts +++ b/scripts/smoke.ts @@ -66,16 +66,16 @@ try { { encoding: "utf8", env: npmEnv, stdio: "pipe" }, ) const env = { - ...Object.fromEntries(Object.entries(process.env).filter(([key]) => !/^(XDG_|HUBSPOT_)/.test(key))), + ...Object.fromEntries(Object.entries(process.env).filter(([key]) => !/^(XDG_|WCHUBSPOT_)/.test(key))), NODE_OPTIONS: "", HOME: temp, DBUS_SESSION_BUS_ADDRESS: "disabled:", - HUBSPOT_CONFIG_DIR: join(temp, "config"), - HUBSPOT_STATE_DIR: join(temp, "state"), - HUBSPOT_CACHE_DIR: join(temp, "cache"), + WCHUBSPOT_CONFIG_DIR: join(temp, "config"), + WCHUBSPOT_STATE_DIR: join(temp, "state"), + WCHUBSPOT_CACHE_DIR: join(temp, "cache"), WIRECAT_STATE_DIR: join(temp, "wirecat"), MESSAGING_STORE: join(temp, "never-owner.db"), - HUBSPOT_NO_UPDATE_CHECK: "1", + WCHUBSPOT_NO_UPDATE_CHECK: "1", } const bin = join(installed, "node_modules", name, "dist/bin/hubspot.js") const run = (args: string[]) => diff --git a/scripts/spec-model.ts b/scripts/spec-model.ts index a302818..c6dda60 100644 --- a/scripts/spec-model.ts +++ b/scripts/spec-model.ts @@ -14,9 +14,27 @@ interface Provenance { sources: { name: string; url: string; file: string; sha256: string }[] } -// SAMPLE: corrections to the service's document, each with the reason from its documentation or a captured answer. const PATCHES: SpecPatch[] = [] +const ASSOCIATION_PATHS = [ + ["put", "/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}"], + ["put", "/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}"], + ["delete", "/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}"], +] as const + +/** + * Corrections to one source before the merge. The associations spec of 2026-03 names three operations it shares with + * every object spec after the 2025-09 path, though the method, path, parameters and bodies are the same; the merge + * takes a shared path once only when the operation ids agree. + */ +const SOURCE_PATCHES: Record = { + associations: ASSOCIATION_PATHS.map(([method, path]) => ({ + pointer: `/paths/${path.replaceAll("~", "~0").replaceAll("/", "~1")}/${method}/operationId`, + value: `${method}-${path}_${path}`, + reason: "the same operation as in each object spec, whose id names the 2026-03 path, not 2025-09", + })), +} + /** * The documents as committed, checked against provenance.json, a Swagger one upgraded to OpenAPI 3, joined when there * are several, then corrected. @@ -24,17 +42,17 @@ const PATCHES: SpecPatch[] = [] export const specModel = async (root: string): Promise<{ model: ApiModel; notes: string[] }> => { const dir = join(root, "spec/hubspot") const provenance = JSON.parse(readFileSync(join(dir, "provenance.json"), "utf8")) as Provenance + const notes: string[] = [] const sources = await Promise.all( provenance.sources.map(async (source) => { const text = readFileSync(join(dir, source.file), "utf8") if (createHash("sha256").update(text).digest("hex") !== source.sha256) throw new Error(`spec/hubspot/${source.file} does not match provenance.json; run pnpm spec:sync`) - const document = JSON.parse(text) as { openapi?: unknown } - return { - name: source.name, - url: source.url, - document: document.openapi ? document : await upgradeToOpenApi3(document), - } + const parsed = JSON.parse(text) as { openapi?: unknown } + const upgraded = parsed.openapi ? parsed : await upgradeToOpenApi3(parsed) + const { document, applied } = patchSpec(upgraded, { patches: SOURCE_PATCHES[source.name] ?? [] }) + notes.push(...applied.map(({ pointer, reason }) => `patched ${source.name} ${pointer}: ${reason}`)) + return { name: source.name, url: source.url, document } }), ) const [only] = sources @@ -50,5 +68,8 @@ export const specModel = async (root: string): Promise<{ model: ApiModel; notes: sourceUrl: provenance.sources.map((source) => source.url).join(" "), sourceRevision: provenance.sources.map((source) => source.sha256).join(" "), }) - return { model, notes: [...merged.notes, ...applied.map(({ pointer, reason }) => `patched ${pointer}: ${reason}`)] } + return { + model, + notes: [...notes, ...merged.notes, ...applied.map(({ pointer, reason }) => `patched ${pointer}: ${reason}`)], + } } diff --git a/skills/hubspot-cli/references/api.md b/skills/hubspot-cli/references/api.md index c9cec7b..9a90a4c 100644 --- a/skills/hubspot-cli/references/api.md +++ b/skills/hubspot-cli/references/api.md @@ -10,4 +10,7 @@ Effects: `read` changes nothing; `write` changes the service; `destructive` dele | Group | Read with | Commands | read | write | destructive | |---|---|---|---|---|---| -| Comments | `hubspot skill show api-comments` | 5 | 2 | 2 | 1 | +| Advanced | `hubspot skill show api-advanced` | 4 | 0 | 0 | 4 | +| Basic | `hubspot skill show api-basic` | 83 | 35 | 32 | 16 | +| Batch | `hubspot skill show api-batch` | 59 | 0 | 46 | 13 | +| Search | `hubspot skill show api-search` | 11 | 11 | 0 | 0 | diff --git a/skills/hubspot-cli/references/api/api-advanced.md b/skills/hubspot-cli/references/api/api-advanced.md new file mode 100644 index 0000000..ce0a41d --- /dev/null +++ b/skills/hubspot-cli/references/api/api-advanced.md @@ -0,0 +1,51 @@ + + +# Example Comments API: Advanced + +## `hubspot api companies-merge [options]` + +- What: Merge two companies +- Call: `POST /crm/objects/2026-03/companies/merge`, effect: destructive +- Permission keys: `organizations.delete` +- Body: `PublicMergeInput`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api contacts-gdpr-delete [options]` + +- What: Permanently delete a contact (GDPR-compliant) +- Call: `POST /crm/objects/2026-03/contacts/gdpr-delete`, effect: destructive +- Permission keys: `people.delete` +- Body: `PublicGdprDeleteInput`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api contacts-merge [options]` + +- What: Merge two contacts +- Call: `POST /crm/objects/2026-03/contacts/merge`, effect: destructive +- Permission keys: `people.delete` +- Body: `PublicMergeInput`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api tickets-merge [options]` + +- What: Merge two tickets +- Call: `POST /crm/objects/2026-03/tickets/merge`, effect: destructive +- Permission keys: `tickets.delete` +- Body: `PublicMergeInput`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | diff --git a/skills/hubspot-cli/references/api/api-basic.md b/skills/hubspot-cli/references/api/api-basic.md new file mode 100644 index 0000000..6a778ce --- /dev/null +++ b/skills/hubspot-cli/references/api/api-basic.md @@ -0,0 +1,1032 @@ + + +# Example Comments API: Basic + +## `hubspot api account-info-api-usage-daily-private-apps-list` + +- What: Retrieve private app daily API usage +- Call: `GET /account-info/2026-03/api-usage/daily/private-apps`, effect: read + +## `hubspot api account-info-details-list` + +- What: Retrieve account details +- Call: `GET /account-info/2026-03/details`, effect: read + +## `hubspot api associations-delete [options]` + +- What: delete-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId} +- Call: `DELETE /crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}`, effect: destructive +- Permission keys: `associations.delete` + +| Flag | Required | What | +|---|---|---| +| `--object-id ` | yes | objectId | +| `--object-type ` | yes | objectType | +| `--to-object-id ` | yes | toObjectId | +| `--to-object-type ` | yes | toObjectType | + +## `hubspot api associations-get [options]` + +- What: Retrieve all associations by object type +- Call: `GET /crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}`, effect: read +- Pages: cursor: send `after` (query), read the next one from `paging.next.after`; items in `results`; page size in `limit` (query) + +| Flag | Required | What | +|---|---|---| +| `--object-id ` | yes | objectId | +| `--object-type ` | yes | objectType | +| `--to-object-type ` | yes | toObjectType | +| `--after ` | no | The paging cursor token of the last successfully read resource will be returned as the \`paging.next.after\` JSON property of a paged response containing more results. | +| `--limit ` | no | The maximum number of results to display per page. | +| `--all` | no | read every page, as the API pages it | + +## `hubspot api associations-replace [options]` + +- What: put-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId} +- Call: `PUT /crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}`, effect: write +- Body: `PutCrmObjects202603ObjectTypeObjectIdAssociationsToObjectTypeToObjectIdCrmObjects202603ObjectTypeObjectIdAssociationsToObjectTypeToObjectIdRequest`, required + +| Flag | Required | What | +|---|---|---| +| `--object-id ` | yes | objectId | +| `--object-type ` | yes | objectType | +| `--to-object-id ` | yes | toObjectId | +| `--to-object-type ` | yes | toObjectType | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api associations-usage-high-usage-report-update [options]` + +- What: Report high usage +- Call: `POST /crm/associations/2026-03/usage/high-usage-report/{userId}`, effect: write + +| Flag | Required | What | +|---|---|---| +| `--user-id ` | yes | userId | + +## `hubspot api calls-create [options]` + +- What: Create +- Call: `POST /crm/objects/2026-03/calls`, effect: write +- Body: `SimplePublicObjectInputForCreate`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api calls-delete [options]` + +- What: Archive +- Call: `DELETE /crm/objects/2026-03/calls/{callId}`, effect: destructive +- Permission keys: `calls.delete` + +| Flag | Required | What | +|---|---|---| +| `--call-id ` | yes | callId | + +## `hubspot api calls-get [options]` + +- What: Read +- Call: `GET /crm/objects/2026-03/calls/{callId}`, effect: read + +| Flag | Required | What | +|---|---|---| +| `--call-id ` | yes | callId | +| `--archived ` | no | Whether to return only results that have been archived. | +| `--associations ` | no | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--id-property ` | no | The name of a property whose values are unique for this object type | +| `--properties ` | no | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | no | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. | + +## `hubspot api calls-list [options]` + +- What: List +- Call: `GET /crm/objects/2026-03/calls`, effect: read +- Pages: cursor: send `after` (query), read the next one from `paging.next.after`; items in `results`; page size in `limit` (query) + +| Flag | Required | What | +|---|---|---| +| `--after ` | no | The paging cursor token of the last successfully read resource will be returned as the \`paging.next.after\` JSON property of a paged response containing more results. | +| `--archived ` | no | Whether to return only results that have been archived. | +| `--associations ` | no | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--limit ` | no | The maximum number of results to display per page. | +| `--properties ` | no | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | no | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. | +| `--all` | no | read every page, as the API pages it | + +## `hubspot api calls-update [options]` + +- What: Update +- Call: `PATCH /crm/objects/2026-03/calls/{callId}`, effect: write +- Body: `SimplePublicObjectInput`, required + +| Flag | Required | What | +|---|---|---| +| `--call-id ` | yes | callId | +| `--id-property ` | no | The name of a property whose values are unique for this object type | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api companies-create [options]` + +- What: Create a company +- Call: `POST /crm/objects/2026-03/companies`, effect: write +- Body: `SimplePublicObjectInputForCreate`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api companies-delete [options]` + +- What: Archive a company +- Call: `DELETE /crm/objects/2026-03/companies/{companyId}`, effect: destructive +- Permission keys: `organizations.delete` + +| Flag | Required | What | +|---|---|---| +| `--company-id ` | yes | companyId | + +## `hubspot api companies-get [options]` + +- What: Retrieve a company +- Call: `GET /crm/objects/2026-03/companies/{companyId}`, effect: read + +| Flag | Required | What | +|---|---|---| +| `--company-id ` | yes | companyId | +| `--archived ` | no | Whether to return only results that have been archived. | +| `--associations ` | no | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--id-property ` | no | The name of a property whose values are unique for this object type | +| `--properties ` | no | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | no | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. | + +## `hubspot api companies-list [options]` + +- What: Retrieve companies +- Call: `GET /crm/objects/2026-03/companies`, effect: read +- Pages: cursor: send `after` (query), read the next one from `paging.next.after`; items in `results`; page size in `limit` (query) + +| Flag | Required | What | +|---|---|---| +| `--after ` | no | The paging cursor token of the last successfully read resource will be returned as the \`paging.next.after\` JSON property of a paged response containing more results. | +| `--archived ` | no | Whether to return only results that have been archived. | +| `--associations ` | no | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--limit ` | no | The maximum number of results to display per page. | +| `--properties ` | no | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | no | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. | +| `--all` | no | read every page, as the API pages it | + +## `hubspot api companies-update [options]` + +- What: Update a company +- Call: `PATCH /crm/objects/2026-03/companies/{companyId}`, effect: write +- Body: `SimplePublicObjectInput`, required + +| Flag | Required | What | +|---|---|---| +| `--company-id ` | yes | companyId | +| `--id-property ` | no | The name of a property whose values are unique for this object type | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api contacts-create [options]` + +- What: Create a contact +- Call: `POST /crm/objects/2026-03/contacts`, effect: write +- Body: `SimplePublicObjectInputForCreate`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api contacts-delete [options]` + +- What: Archive a contact +- Call: `DELETE /crm/objects/2026-03/contacts/{contactId}`, effect: destructive +- Permission keys: `people.delete` + +| Flag | Required | What | +|---|---|---| +| `--contact-id ` | yes | contactId | + +## `hubspot api contacts-get [options]` + +- What: Retrieve a contact +- Call: `GET /crm/objects/2026-03/contacts/{contactId}`, effect: read + +| Flag | Required | What | +|---|---|---| +| `--contact-id ` | yes | contactId | +| `--archived ` | no | Whether to return only results that have been archived. | +| `--associations ` | no | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--id-property ` | no | The name of a property whose values are unique for this object type | +| `--properties ` | no | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | no | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. | + +## `hubspot api contacts-list [options]` + +- What: Retrieve contacts +- Call: `GET /crm/objects/2026-03/contacts`, effect: read +- Pages: cursor: send `after` (query), read the next one from `paging.next.after`; items in `results`; page size in `limit` (query) + +| Flag | Required | What | +|---|---|---| +| `--after ` | no | The paging cursor token of the last successfully read resource will be returned as the \`paging.next.after\` JSON property of a paged response containing more results. | +| `--archived ` | no | Whether to return only results that have been archived. | +| `--associations ` | no | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--limit ` | no | The maximum number of results to display per page. | +| `--properties ` | no | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | no | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. | +| `--all` | no | read every page, as the API pages it | + +## `hubspot api contacts-update [options]` + +- What: Update a contact +- Call: `PATCH /crm/objects/2026-03/contacts/{contactId}`, effect: write +- Body: `SimplePublicObjectInput`, required + +| Flag | Required | What | +|---|---|---| +| `--contact-id ` | yes | contactId | +| `--id-property ` | no | The name of a property whose values are unique for this object type | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api deals-create [options]` + +- What: Create +- Call: `POST /crm/objects/2026-03/0-3`, effect: write +- Body: `SimplePublicObjectInputForCreate`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api deals-delete [options]` + +- What: Archive +- Call: `DELETE /crm/objects/2026-03/0-3/{dealId}`, effect: destructive +- Permission keys: `deals.delete` + +| Flag | Required | What | +|---|---|---| +| `--deal-id ` | yes | dealId | + +## `hubspot api deals-get [options]` + +- What: Read +- Call: `GET /crm/objects/2026-03/0-3/{dealId}`, effect: read + +| Flag | Required | What | +|---|---|---| +| `--deal-id ` | yes | dealId | +| `--archived ` | no | Whether to return only results that have been archived. | +| `--associations ` | no | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--id-property ` | no | The name of a property whose values are unique for this object type | +| `--properties ` | no | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | no | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. | + +## `hubspot api deals-list [options]` + +- What: List +- Call: `GET /crm/objects/2026-03/0-3`, effect: read +- Pages: cursor: send `after` (query), read the next one from `paging.next.after`; items in `results`; page size in `limit` (query) + +| Flag | Required | What | +|---|---|---| +| `--after ` | no | The paging cursor token of the last successfully read resource will be returned as the \`paging.next.after\` JSON property of a paged response containing more results. | +| `--archived ` | no | Whether to return only results that have been archived. | +| `--associations ` | no | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--limit ` | no | The maximum number of results to display per page. | +| `--properties ` | no | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | no | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. | +| `--all` | no | read every page, as the API pages it | + +## `hubspot api deals-merge [options]` + +- What: Merge two deals with same type +- Call: `POST /crm/objects/2026-03/0-3/merge`, effect: destructive +- Permission keys: `deals.delete` +- Body: `PublicMergeInput`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api deals-update [options]` + +- What: Update +- Call: `PATCH /crm/objects/2026-03/0-3/{dealId}`, effect: write +- Body: `SimplePublicObjectInput`, required + +| Flag | Required | What | +|---|---|---| +| `--deal-id ` | yes | dealId | +| `--id-property ` | no | The name of a property whose values are unique for this object type | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api emails-create [options]` + +- What: Create +- Call: `POST /crm/objects/2026-03/emails`, effect: write +- Body: `SimplePublicObjectInputForCreate`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api emails-delete [options]` + +- What: Archive +- Call: `DELETE /crm/objects/2026-03/emails/{emailId}`, effect: destructive +- Permission keys: `emails.delete` + +| Flag | Required | What | +|---|---|---| +| `--email-id ` | yes | emailId | + +## `hubspot api emails-get [options]` + +- What: Read +- Call: `GET /crm/objects/2026-03/emails/{emailId}`, effect: read + +| Flag | Required | What | +|---|---|---| +| `--email-id ` | yes | emailId | +| `--archived ` | no | Whether to return only results that have been archived. | +| `--associations ` | no | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--id-property ` | no | The name of a property whose values are unique for this object type | +| `--properties ` | no | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | no | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. | + +## `hubspot api emails-list [options]` + +- What: List +- Call: `GET /crm/objects/2026-03/emails`, effect: read +- Pages: cursor: send `after` (query), read the next one from `paging.next.after`; items in `results`; page size in `limit` (query) + +| Flag | Required | What | +|---|---|---| +| `--after ` | no | The paging cursor token of the last successfully read resource will be returned as the \`paging.next.after\` JSON property of a paged response containing more results. | +| `--archived ` | no | Whether to return only results that have been archived. | +| `--associations ` | no | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--limit ` | no | The maximum number of results to display per page. | +| `--properties ` | no | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | no | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. | +| `--all` | no | read every page, as the API pages it | + +## `hubspot api emails-update [options]` + +- What: Update +- Call: `PATCH /crm/objects/2026-03/emails/{emailId}`, effect: write +- Body: `SimplePublicObjectInput`, required + +| Flag | Required | What | +|---|---|---| +| `--email-id ` | yes | emailId | +| `--id-property ` | no | The name of a property whose values are unique for this object type | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api leads-create [options]` + +- What: Create +- Call: `POST /crm/objects/2026-03/leads`, effect: write +- Body: `SimplePublicObjectInputForCreate`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api leads-delete [options]` + +- What: Archive +- Call: `DELETE /crm/objects/2026-03/leads/{leadsId}`, effect: destructive +- Permission keys: `leads.delete` + +| Flag | Required | What | +|---|---|---| +| `--leads-id ` | yes | leadsId | + +## `hubspot api leads-get [options]` + +- What: Read +- Call: `GET /crm/objects/2026-03/leads/{leadsId}`, effect: read + +| Flag | Required | What | +|---|---|---| +| `--leads-id ` | yes | leadsId | +| `--archived ` | no | Whether to return only results that have been archived. | +| `--associations ` | no | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--id-property ` | no | The name of a property whose values are unique for this object type | +| `--properties ` | no | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | no | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. | + +## `hubspot api leads-list [options]` + +- What: List +- Call: `GET /crm/objects/2026-03/leads`, effect: read +- Pages: cursor: send `after` (query), read the next one from `paging.next.after`; items in `results`; page size in `limit` (query) + +| Flag | Required | What | +|---|---|---| +| `--after ` | no | The paging cursor token of the last successfully read resource will be returned as the \`paging.next.after\` JSON property of a paged response containing more results. | +| `--archived ` | no | Whether to return only results that have been archived. | +| `--associations ` | no | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--limit ` | no | The maximum number of results to display per page. | +| `--properties ` | no | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | no | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. | +| `--all` | no | read every page, as the API pages it | + +## `hubspot api leads-update [options]` + +- What: Update +- Call: `PATCH /crm/objects/2026-03/leads/{leadsId}`, effect: write +- Body: `SimplePublicObjectInput`, required + +| Flag | Required | What | +|---|---|---| +| `--leads-id ` | yes | leadsId | +| `--id-property ` | no | The name of a property whose values are unique for this object type | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api meetings-create [options]` + +- What: Create +- Call: `POST /crm/objects/2026-03/meetings`, effect: write +- Body: `SimplePublicObjectInputForCreate`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api meetings-delete [options]` + +- What: Archive +- Call: `DELETE /crm/objects/2026-03/meetings/{meetingId}`, effect: destructive +- Permission keys: `meetings.delete` + +| Flag | Required | What | +|---|---|---| +| `--meeting-id ` | yes | meetingId | + +## `hubspot api meetings-get [options]` + +- What: Read +- Call: `GET /crm/objects/2026-03/meetings/{meetingId}`, effect: read + +| Flag | Required | What | +|---|---|---| +| `--meeting-id ` | yes | meetingId | +| `--archived ` | no | Whether to return only results that have been archived. | +| `--associations ` | no | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--id-property ` | no | The name of a property whose values are unique for this object type | +| `--properties ` | no | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | no | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. | + +## `hubspot api meetings-list [options]` + +- What: List +- Call: `GET /crm/objects/2026-03/meetings`, effect: read +- Pages: cursor: send `after` (query), read the next one from `paging.next.after`; items in `results`; page size in `limit` (query) + +| Flag | Required | What | +|---|---|---| +| `--after ` | no | The paging cursor token of the last successfully read resource will be returned as the \`paging.next.after\` JSON property of a paged response containing more results. | +| `--archived ` | no | Whether to return only results that have been archived. | +| `--associations ` | no | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--limit ` | no | The maximum number of results to display per page. | +| `--properties ` | no | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | no | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. | +| `--all` | no | read every page, as the API pages it | + +## `hubspot api meetings-update [options]` + +- What: Update +- Call: `PATCH /crm/objects/2026-03/meetings/{meetingId}`, effect: write +- Body: `SimplePublicObjectInput`, required + +| Flag | Required | What | +|---|---|---| +| `--meeting-id ` | yes | meetingId | +| `--id-property ` | no | The name of a property whose values are unique for this object type | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api notes-create [options]` + +- What: Create +- Call: `POST /crm/objects/2026-03/notes`, effect: write +- Body: `SimplePublicObjectInputForCreate`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api notes-delete [options]` + +- What: Archive +- Call: `DELETE /crm/objects/2026-03/notes/{noteId}`, effect: destructive +- Permission keys: `notes.delete` + +| Flag | Required | What | +|---|---|---| +| `--note-id ` | yes | noteId | + +## `hubspot api notes-get [options]` + +- What: Read +- Call: `GET /crm/objects/2026-03/notes/{noteId}`, effect: read + +| Flag | Required | What | +|---|---|---| +| `--note-id ` | yes | noteId | +| `--archived ` | no | Whether to return only results that have been archived. | +| `--associations ` | no | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--id-property ` | no | The name of a property whose values are unique for this object type | +| `--properties ` | no | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | no | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. | + +## `hubspot api notes-list [options]` + +- What: List +- Call: `GET /crm/objects/2026-03/notes`, effect: read +- Pages: cursor: send `after` (query), read the next one from `paging.next.after`; items in `results`; page size in `limit` (query) + +| Flag | Required | What | +|---|---|---| +| `--after ` | no | The paging cursor token of the last successfully read resource will be returned as the \`paging.next.after\` JSON property of a paged response containing more results. | +| `--archived ` | no | Whether to return only results that have been archived. | +| `--associations ` | no | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--limit ` | no | The maximum number of results to display per page. | +| `--properties ` | no | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | no | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. | +| `--all` | no | read every page, as the API pages it | + +## `hubspot api notes-update [options]` + +- What: Update +- Call: `PATCH /crm/objects/2026-03/notes/{noteId}`, effect: write +- Body: `SimplePublicObjectInput`, required + +| Flag | Required | What | +|---|---|---| +| `--note-id ` | yes | noteId | +| `--id-property ` | no | The name of a property whose values are unique for this object type | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api owners-get [options]` + +- What: Retrieve a specific owner by ID +- Call: `GET /crm/owners/2026-03/{ownerId}`, effect: read + +| Flag | Required | What | +|---|---|---| +| `--owner-id ` | yes | The unique identifier of the owner to retrieve. | +| `--archived ` | no | Whether to return only results that have been archived. | +| `--id-property ` | no | Specifies which property to use for identifying the owner. Valid values are 'id' or 'userId'. Defaults to 'id'. | + +## `hubspot api owners-list [options]` + +- What: List owners +- Call: `GET /crm/owners/2026-03`, effect: read +- Pages: cursor: send `after` (query), read the next one from `paging.next.after`; items in `results`; page size in `limit` (query) + +| Flag | Required | What | +|---|---|---| +| `--after ` | no | The paging cursor token of the last successfully read resource will be returned as the \`paging.next.after\` JSON property of a paged response containing more results. | +| `--archived ` | no | Whether to return only results that have been archived. | +| `--email ` | no | Filter by email address (optional) | +| `--limit ` | no | The maximum number of results to display per page. | +| `--all` | no | read every page, as the API pages it | + +## `hubspot api pipelines-audit-list [options]` + +- What: Return an audit of all changes to the pipeline +- Call: `GET /crm/pipelines/2026-03/{objectType}/{pipelineId}/audit`, effect: read + +| Flag | Required | What | +|---|---|---| +| `--object-type ` | yes | objectType | +| `--pipeline-id ` | yes | pipelineId | + +## `hubspot api pipelines-create [options]` + +- What: Create a pipeline +- Call: `POST /crm/pipelines/2026-03/{objectType}`, effect: write +- Body: `PipelineInput`, required + +| Flag | Required | What | +|---|---|---| +| `--object-type ` | yes | objectType | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api pipelines-delete [options]` + +- What: Delete a pipeline +- Call: `DELETE /crm/pipelines/2026-03/{objectType}/{pipelineId}`, effect: destructive +- Permission keys: `pipelines.delete` + +| Flag | Required | What | +|---|---|---| +| `--object-type ` | yes | objectType | +| `--pipeline-id ` | yes | pipelineId | +| `--validate-deal-stage-usages-before-delete ` | no | validateDealStageUsagesBeforeDelete | +| `--validate-references-before-delete ` | no | validateReferencesBeforeDelete | + +## `hubspot api pipelines-get [options]` + +- What: Return a pipeline by ID +- Call: `GET /crm/pipelines/2026-03/{objectType}/{pipelineId}`, effect: read + +| Flag | Required | What | +|---|---|---| +| `--object-type ` | yes | objectType | +| `--pipeline-id ` | yes | pipelineId | + +## `hubspot api pipelines-list [options]` + +- What: Retrieve all pipelines +- Call: `GET /crm/pipelines/2026-03/{objectType}`, effect: read + +| Flag | Required | What | +|---|---|---| +| `--object-type ` | yes | objectType | + +## `hubspot api pipelines-replace [options]` + +- What: Replace a pipeline +- Call: `PUT /crm/pipelines/2026-03/{objectType}/{pipelineId}`, effect: write +- Body: `PipelineReplaceInput`, required + +| Flag | Required | What | +|---|---|---| +| `--object-type ` | yes | objectType | +| `--pipeline-id ` | yes | pipelineId | +| `--validate-deal-stage-usages-before-delete ` | no | validateDealStageUsagesBeforeDelete | +| `--validate-references-before-delete ` | no | validateReferencesBeforeDelete | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api pipelines-stages-audit-list [options]` + +- What: Retrieve a reverse chronological list of all changes made to a specific pipeline stage. +- Call: `GET /crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}/audit`, effect: read + +| Flag | Required | What | +|---|---|---| +| `--object-type ` | yes | objectType | +| `--pipeline-id ` | yes | pipelineId | +| `--stage-id ` | yes | stageId | + +## `hubspot api pipelines-stages-create [options]` + +- What: Create a pipeline stage +- Call: `POST /crm/pipelines/2026-03/{objectType}/{pipelineId}/stages`, effect: write +- Body: `PipelineStageInput`, required + +| Flag | Required | What | +|---|---|---| +| `--object-type ` | yes | objectType | +| `--pipeline-id ` | yes | pipelineId | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api pipelines-stages-delete [options]` + +- What: Delete a pipeline stage +- Call: `DELETE /crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}`, effect: destructive +- Permission keys: `pipelines.delete` + +| Flag | Required | What | +|---|---|---| +| `--object-type ` | yes | objectType | +| `--pipeline-id ` | yes | pipelineId | +| `--stage-id ` | yes | stageId | +| `--validate-references-before-delete ` | no | validateReferencesBeforeDelete | + +## `hubspot api pipelines-stages-get [options]` + +- What: Return a pipeline stage by ID +- Call: `GET /crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}`, effect: read + +| Flag | Required | What | +|---|---|---| +| `--object-type ` | yes | objectType | +| `--pipeline-id ` | yes | pipelineId | +| `--stage-id ` | yes | stageId | + +## `hubspot api pipelines-stages-list [options]` + +- What: Return all stages of a pipeline +- Call: `GET /crm/pipelines/2026-03/{objectType}/{pipelineId}/stages`, effect: read + +| Flag | Required | What | +|---|---|---| +| `--object-type ` | yes | objectType | +| `--pipeline-id ` | yes | pipelineId | + +## `hubspot api pipelines-stages-replace [options]` + +- What: Replace a pipeline stage +- Call: `PUT /crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}`, effect: write +- Body: `PipelineStageReplaceInput`, required + +| Flag | Required | What | +|---|---|---| +| `--object-type ` | yes | objectType | +| `--pipeline-id ` | yes | pipelineId | +| `--stage-id ` | yes | stageId | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api pipelines-stages-update [options]` + +- What: Update specific properties of an existing pipeline stage. +- Call: `PATCH /crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}`, effect: write +- Body: `PipelineStagePatchInput`, required + +| Flag | Required | What | +|---|---|---| +| `--object-type ` | yes | objectType | +| `--pipeline-id ` | yes | pipelineId | +| `--stage-id ` | yes | stageId | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api pipelines-update [options]` + +- What: Perform a partial update of the pipeline identified by pipelineId. +- Call: `PATCH /crm/pipelines/2026-03/{objectType}/{pipelineId}`, effect: write +- Body: `PipelinePatchInput`, required + +| Flag | Required | What | +|---|---|---| +| `--object-type ` | yes | objectType | +| `--pipeline-id ` | yes | pipelineId | +| `--validate-deal-stage-usages-before-delete ` | no | validateDealStageUsagesBeforeDelete | +| `--validate-references-before-delete ` | no | validateReferencesBeforeDelete | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api properties-create [options]` + +- What: Create a property +- Call: `POST /crm/properties/2026-03/{objectType}`, effect: write +- Body: `PropertyCreate`, required + +| Flag | Required | What | +|---|---|---| +| `--object-type ` | yes | The type of object for which the property is being created, such as contacts, companies, or deals. | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api properties-delete [options]` + +- What: Archive a property +- Call: `DELETE /crm/properties/2026-03/{objectType}/{propertyName}`, effect: destructive +- Permission keys: `fields.delete` + +| Flag | Required | What | +|---|---|---| +| `--object-type ` | yes | The type of CRM object that the property belongs to, such as contacts, companies, or deals. | +| `--property-name ` | yes | The unique name of the property to delete. | + +## `hubspot api properties-get [options]` + +- What: Read a property +- Call: `GET /crm/properties/2026-03/{objectType}/{propertyName}`, effect: read + +| Flag | Required | What | +|---|---|---| +| `--object-type ` | yes | The type of object the property belongs to, such as 'contacts' or 'deals'. | +| `--property-name ` | yes | The name of the property to retrieve. | +| `--archived ` | no | Whether to return only results that have been archived. | +| `--data-sensitivity ` | no | The level of data sensitivity to filter properties by. Valid values are 'non\_sensitive', 'sensitive', and 'highly\_sensitive'. Defaults to 'non\_sensitive'. | +| `--locale ` | no | The locale to use for property labels and descriptions. | +| `--properties ` | no | A comma-separated list of property names to include in the response. | + +## `hubspot api properties-groups-create [options]` + +- What: Create a property group +- Call: `POST /crm/properties/2026-03/{objectType}/groups`, effect: write +- Body: `PropertyGroupCreate`, required + +| Flag | Required | What | +|---|---|---| +| `--object-type ` | yes | The type of object for which the property group is being created, such as contacts, companies, or deals. | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api properties-groups-delete [options]` + +- What: Archive a property group +- Call: `DELETE /crm/properties/2026-03/{objectType}/groups/{groupName}`, effect: destructive +- Permission keys: `fields.delete` + +| Flag | Required | What | +|---|---|---| +| `--group-name ` | yes | The unique name of the property group to be deleted. | +| `--object-type ` | yes | The type of object for which the property group is defined, such as contacts, companies, or deals. | + +## `hubspot api properties-groups-get [options]` + +- What: Read a property group +- Call: `GET /crm/properties/2026-03/{objectType}/groups/{groupName}`, effect: read + +| Flag | Required | What | +|---|---|---| +| `--group-name ` | yes | The name of the property group to retrieve details for. | +| `--object-type ` | yes | The type of CRM object for which the property group is being retrieved, such as contacts or deals. | +| `--locale ` | no | The language locale to use for the response. This can affect the language of the labels and descriptions returned. | + +## `hubspot api properties-groups-list [options]` + +- What: Read all property groups +- Call: `GET /crm/properties/2026-03/{objectType}/groups`, effect: read + +| Flag | Required | What | +|---|---|---| +| `--object-type ` | yes | The type of CRM object for which to retrieve property groups, such as 'contacts' or 'deals'. | +| `--locale ` | no | The language locale to use for property group labels. This can help in displaying labels in the preferred language. | + +## `hubspot api properties-groups-update [options]` + +- What: Update a property group +- Call: `PATCH /crm/properties/2026-03/{objectType}/groups/{groupName}`, effect: write +- Body: `PropertyGroupUpdate`, required + +| Flag | Required | What | +|---|---|---| +| `--group-name ` | yes | The name of the property group to update. | +| `--object-type ` | yes | The type of object for which the property group is being updated, such as contacts, companies, or deals. | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api properties-list [options]` + +- What: Read all properties +- Call: `GET /crm/properties/2026-03/{objectType}`, effect: read + +| Flag | Required | What | +|---|---|---| +| `--object-type ` | yes | The type of CRM object for which properties are being retrieved, such as 'contacts', 'companies', etc. | +| `--archived ` | no | Whether to return only results that have been archived. | +| `--data-sensitivity ` | no | Filter properties based on data sensitivity level. Valid values are 'non\_sensitive', 'sensitive', and 'highly\_sensitive'. Defaults to 'non\_sensitive'. | +| `--locale ` | no | Specify the locale to retrieve properties in a particular language or regional format. | +| `--properties ` | no | A comma-separated list of property names to include in the response. | + +## `hubspot api properties-update [options]` + +- What: Update a property +- Call: `PATCH /crm/properties/2026-03/{objectType}/{propertyName}`, effect: write +- Body: `PropertyUpdate`, required + +| Flag | Required | What | +|---|---|---| +| `--object-type ` | yes | The type of object for which the property is being updated, such as contacts, companies, or deals. | +| `--property-name ` | yes | The unique name of the property to update. | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api tasks-create [options]` + +- What: Create +- Call: `POST /crm/objects/2026-03/tasks`, effect: write +- Body: `SimplePublicObjectInputForCreate`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api tasks-delete [options]` + +- What: Archive +- Call: `DELETE /crm/objects/2026-03/tasks/{taskId}`, effect: destructive +- Permission keys: `tasks.delete` + +| Flag | Required | What | +|---|---|---| +| `--task-id ` | yes | taskId | + +## `hubspot api tasks-get [options]` + +- What: Read +- Call: `GET /crm/objects/2026-03/tasks/{taskId}`, effect: read + +| Flag | Required | What | +|---|---|---| +| `--task-id ` | yes | taskId | +| `--archived ` | no | Whether to return only results that have been archived. | +| `--associations ` | no | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--id-property ` | no | The name of a property whose values are unique for this object type | +| `--properties ` | no | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | no | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. | + +## `hubspot api tasks-list [options]` + +- What: List +- Call: `GET /crm/objects/2026-03/tasks`, effect: read +- Pages: cursor: send `after` (query), read the next one from `paging.next.after`; items in `results`; page size in `limit` (query) + +| Flag | Required | What | +|---|---|---| +| `--after ` | no | The paging cursor token of the last successfully read resource will be returned as the \`paging.next.after\` JSON property of a paged response containing more results. | +| `--archived ` | no | Whether to return only results that have been archived. | +| `--associations ` | no | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--limit ` | no | The maximum number of results to display per page. | +| `--properties ` | no | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | no | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. | +| `--all` | no | read every page, as the API pages it | + +## `hubspot api tasks-update [options]` + +- What: Update +- Call: `PATCH /crm/objects/2026-03/tasks/{taskId}`, effect: write +- Body: `SimplePublicObjectInput`, required + +| Flag | Required | What | +|---|---|---| +| `--task-id ` | yes | taskId | +| `--id-property ` | no | The name of a property whose values are unique for this object type | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api tickets-create [options]` + +- What: Create +- Call: `POST /crm/objects/2026-03/tickets`, effect: write +- Body: `SimplePublicObjectInputForCreate`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api tickets-delete [options]` + +- What: Archive +- Call: `DELETE /crm/objects/2026-03/tickets/{ticketId}`, effect: destructive +- Permission keys: `tickets.delete` + +| Flag | Required | What | +|---|---|---| +| `--ticket-id ` | yes | ticketId | + +## `hubspot api tickets-get [options]` + +- What: Read +- Call: `GET /crm/objects/2026-03/tickets/{ticketId}`, effect: read + +| Flag | Required | What | +|---|---|---| +| `--ticket-id ` | yes | ticketId | +| `--archived ` | no | Whether to return only results that have been archived. | +| `--associations ` | no | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--id-property ` | no | The name of a property whose values are unique for this object type | +| `--properties ` | no | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | no | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. | + +## `hubspot api tickets-list [options]` + +- What: List +- Call: `GET /crm/objects/2026-03/tickets`, effect: read +- Pages: cursor: send `after` (query), read the next one from `paging.next.after`; items in `results`; page size in `limit` (query) + +| Flag | Required | What | +|---|---|---| +| `--after ` | no | The paging cursor token of the last successfully read resource will be returned as the \`paging.next.after\` JSON property of a paged response containing more results. | +| `--archived ` | no | Whether to return only results that have been archived. | +| `--associations ` | no | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | +| `--limit ` | no | The maximum number of results to display per page. | +| `--properties ` | no | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | +| `--properties-with-history ` | no | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. | +| `--all` | no | read every page, as the API pages it | + +## `hubspot api tickets-update [options]` + +- What: Update +- Call: `PATCH /crm/objects/2026-03/tickets/{ticketId}`, effect: write +- Body: `SimplePublicObjectInput`, required + +| Flag | Required | What | +|---|---|---| +| `--ticket-id ` | yes | ticketId | +| `--id-property ` | no | The name of a property whose values are unique for this object type | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | diff --git a/skills/hubspot-cli/references/api/api-batch.md b/skills/hubspot-cli/references/api/api-batch.md new file mode 100644 index 0000000..97d195e --- /dev/null +++ b/skills/hubspot-cli/references/api/api-batch.md @@ -0,0 +1,690 @@ + + +# Example Comments API: Batch + +## `hubspot api associations-batch-archive [options]` + +- What: Remove associations +- Call: `POST /crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/archive`, effect: destructive +- Permission keys: `associations.delete` +- Body: `BatchInputPublicAssociationMultiArchive`, required + +| Flag | Required | What | +|---|---|---| +| `--from-object-type ` | yes | fromObjectType | +| `--to-object-type ` | yes | toObjectType | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api associations-batch-associate-default [options]` + +- What: Create Default Associations +- Call: `POST /crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/associate/default`, effect: write +- Body: `BatchInputPublicDefaultAssociationMultiPost`, required + +| Flag | Required | What | +|---|---|---| +| `--from-object-type ` | yes | fromObjectType | +| `--to-object-type ` | yes | toObjectType | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api associations-batch-create [options]` + +- What: Associate records (labelled) +- Call: `POST /crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/create`, effect: write +- Body: `BatchInputPublicAssociationMultiPost`, required + +| Flag | Required | What | +|---|---|---| +| `--from-object-type ` | yes | fromObjectType | +| `--to-object-type ` | yes | toObjectType | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api associations-batch-labels-archive [options]` + +- What: Delete Specific Labels +- Call: `POST /crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/labels/archive`, effect: destructive +- Permission keys: `associations.delete` +- Body: `BatchInputPublicAssociationMultiPost`, required + +| Flag | Required | What | +|---|---|---| +| `--from-object-type ` | yes | fromObjectType | +| `--to-object-type ` | yes | toObjectType | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api associations-batch-read [options]` + +- What: Retrieve associations +- Call: `POST /crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/read`, effect: write +- Body: `BatchInputPublicFetchAssociationsBatchRequest`, required + +| Flag | Required | What | +|---|---|---| +| `--from-object-type ` | yes | fromObjectType | +| `--to-object-type ` | yes | toObjectType | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api associations-default-replace [options]` + +- What: put-/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId} +- Call: `PUT /crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}`, effect: write + +| Flag | Required | What | +|---|---|---| +| `--from-object-id ` | yes | fromObjectId | +| `--from-object-type ` | yes | fromObjectType | +| `--to-object-id ` | yes | toObjectId | +| `--to-object-type ` | yes | toObjectType | + +## `hubspot api calls-batch-archive [options]` + +- What: Archive a batch of calls by ID +- Call: `POST /crm/objects/2026-03/calls/batch/archive`, effect: destructive +- Permission keys: `calls.delete` +- Body: `BatchInputSimplePublicObjectId`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api calls-batch-create [options]` + +- What: Create a batch of calls +- Call: `POST /crm/objects/2026-03/calls/batch/create`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInputForCreate`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api calls-batch-read [options]` + +- What: Read a batch of calls by internal ID, or unique property values +- Call: `POST /crm/objects/2026-03/calls/batch/read`, effect: write +- Body: `BatchReadInputSimplePublicObjectId`, required + +| Flag | Required | What | +|---|---|---| +| `--archived ` | no | Whether to return only results that have been archived. | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api calls-batch-update [options]` + +- What: Update a batch of calls by internal ID, or unique property values +- Call: `POST /crm/objects/2026-03/calls/batch/update`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInput`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api calls-batch-upsert [options]` + +- What: Create or update a batch of calls by unique property values +- Call: `POST /crm/objects/2026-03/calls/batch/upsert`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInputUpsert`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api companies-batch-archive [options]` + +- What: Archive a batch of companies +- Call: `POST /crm/objects/2026-03/companies/batch/archive`, effect: destructive +- Permission keys: `organizations.delete` +- Body: `BatchInputSimplePublicObjectId`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api companies-batch-create [options]` + +- What: Create a batch of companies +- Call: `POST /crm/objects/2026-03/companies/batch/create`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInputForCreate`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api companies-batch-read [options]` + +- What: Retrieve a batch of companies +- Call: `POST /crm/objects/2026-03/companies/batch/read`, effect: write +- Body: `BatchReadInputSimplePublicObjectId`, required + +| Flag | Required | What | +|---|---|---| +| `--archived ` | no | Whether to return only results that have been archived. | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api companies-batch-update [options]` + +- What: Update a batch of companies +- Call: `POST /crm/objects/2026-03/companies/batch/update`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInput`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api companies-batch-upsert [options]` + +- What: Create or update a batch of companies by unique property values +- Call: `POST /crm/objects/2026-03/companies/batch/upsert`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInputUpsert`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api contacts-batch-archive [options]` + +- What: Archive a batch of contacts +- Call: `POST /crm/objects/2026-03/contacts/batch/archive`, effect: destructive +- Permission keys: `people.delete` +- Body: `BatchInputSimplePublicObjectId`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api contacts-batch-create [options]` + +- What: Create a batch of contacts +- Call: `POST /crm/objects/2026-03/contacts/batch/create`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInputForCreate`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api contacts-batch-read [options]` + +- What: Retrieve a batch of contacts +- Call: `POST /crm/objects/2026-03/contacts/batch/read`, effect: write +- Body: `BatchReadInputSimplePublicObjectId`, required + +| Flag | Required | What | +|---|---|---| +| `--archived ` | no | Whether to return only results that have been archived. | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api contacts-batch-update [options]` + +- What: Update a batch of contacts +- Call: `POST /crm/objects/2026-03/contacts/batch/update`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInput`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api contacts-batch-upsert [options]` + +- What: Create or update a batch of contacts +- Call: `POST /crm/objects/2026-03/contacts/batch/upsert`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInputUpsert`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api deals-batch-archive [options]` + +- What: Archive a batch of deals by ID +- Call: `POST /crm/objects/2026-03/0-3/batch/archive`, effect: destructive +- Permission keys: `deals.delete` +- Body: `BatchInputSimplePublicObjectId`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api deals-batch-create [options]` + +- What: Create a batch of deals +- Call: `POST /crm/objects/2026-03/0-3/batch/create`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInputForCreate`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api deals-batch-read [options]` + +- What: Read a batch of deals by internal ID, or unique property values +- Call: `POST /crm/objects/2026-03/0-3/batch/read`, effect: write +- Body: `BatchReadInputSimplePublicObjectId`, required + +| Flag | Required | What | +|---|---|---| +| `--archived ` | no | Whether to return only results that have been archived. | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api deals-batch-update [options]` + +- What: Update a batch of deals by internal ID, or unique property values +- Call: `POST /crm/objects/2026-03/0-3/batch/update`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInput`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api deals-batch-upsert [options]` + +- What: Create or update a batch of deals by unique property values +- Call: `POST /crm/objects/2026-03/0-3/batch/upsert`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInputUpsert`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api emails-batch-archive [options]` + +- What: Archive a batch of emails by ID +- Call: `POST /crm/objects/2026-03/emails/batch/archive`, effect: destructive +- Permission keys: `emails.delete` +- Body: `BatchInputSimplePublicObjectId`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api emails-batch-create [options]` + +- What: Create a batch of emails +- Call: `POST /crm/objects/2026-03/emails/batch/create`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInputForCreate`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api emails-batch-read [options]` + +- What: Read a batch of emails by internal ID, or unique property values +- Call: `POST /crm/objects/2026-03/emails/batch/read`, effect: write +- Body: `BatchReadInputSimplePublicObjectId`, required + +| Flag | Required | What | +|---|---|---| +| `--archived ` | no | Whether to return only results that have been archived. | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api emails-batch-update [options]` + +- What: Update a batch of emails by internal ID, or unique property values +- Call: `POST /crm/objects/2026-03/emails/batch/update`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInput`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api emails-batch-upsert [options]` + +- What: Create or update a batch of emails by unique property values +- Call: `POST /crm/objects/2026-03/emails/batch/upsert`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInputUpsert`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api leads-batch-archive [options]` + +- What: Archive a batch of leads by ID +- Call: `POST /crm/objects/2026-03/leads/batch/archive`, effect: destructive +- Permission keys: `leads.delete` +- Body: `BatchInputSimplePublicObjectId`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api leads-batch-create [options]` + +- What: Create a batch of leads +- Call: `POST /crm/objects/2026-03/leads/batch/create`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInputForCreate`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api leads-batch-read [options]` + +- What: Read a batch of leads by internal ID, or unique property values +- Call: `POST /crm/objects/2026-03/leads/batch/read`, effect: write +- Body: `BatchReadInputSimplePublicObjectId`, required + +| Flag | Required | What | +|---|---|---| +| `--archived ` | no | Whether to return only results that have been archived. | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api leads-batch-update [options]` + +- What: Update a batch of leads by internal ID, or unique property values +- Call: `POST /crm/objects/2026-03/leads/batch/update`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInput`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api leads-batch-upsert [options]` + +- What: Create or update a batch of leads by unique property values +- Call: `POST /crm/objects/2026-03/leads/batch/upsert`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInputUpsert`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api meetings-batch-archive [options]` + +- What: Archive a batch of meetings by ID +- Call: `POST /crm/objects/2026-03/meetings/batch/archive`, effect: destructive +- Permission keys: `meetings.delete` +- Body: `BatchInputSimplePublicObjectId`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api meetings-batch-create [options]` + +- What: Create a batch of meetings +- Call: `POST /crm/objects/2026-03/meetings/batch/create`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInputForCreate`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api meetings-batch-read [options]` + +- What: Read a batch of meetings by internal ID, or unique property values +- Call: `POST /crm/objects/2026-03/meetings/batch/read`, effect: write +- Body: `BatchReadInputSimplePublicObjectId`, required + +| Flag | Required | What | +|---|---|---| +| `--archived ` | no | Whether to return only results that have been archived. | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api meetings-batch-update [options]` + +- What: Update a batch of meetings by internal ID, or unique property values +- Call: `POST /crm/objects/2026-03/meetings/batch/update`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInput`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api meetings-batch-upsert [options]` + +- What: Create or update a batch of meetings by unique property values +- Call: `POST /crm/objects/2026-03/meetings/batch/upsert`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInputUpsert`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api notes-batch-archive [options]` + +- What: Archive a batch of notes by ID +- Call: `POST /crm/objects/2026-03/notes/batch/archive`, effect: destructive +- Permission keys: `notes.delete` +- Body: `BatchInputSimplePublicObjectId`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api notes-batch-create [options]` + +- What: Create a batch of notes +- Call: `POST /crm/objects/2026-03/notes/batch/create`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInputForCreate`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api notes-batch-read [options]` + +- What: Read a batch of notes by internal ID, or unique property values +- Call: `POST /crm/objects/2026-03/notes/batch/read`, effect: write +- Body: `BatchReadInputSimplePublicObjectId`, required + +| Flag | Required | What | +|---|---|---| +| `--archived ` | no | Whether to return only results that have been archived. | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api notes-batch-update [options]` + +- What: Update a batch of notes by internal ID, or unique property values +- Call: `POST /crm/objects/2026-03/notes/batch/update`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInput`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api notes-batch-upsert [options]` + +- What: Create or update a batch of notes by unique property values +- Call: `POST /crm/objects/2026-03/notes/batch/upsert`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInputUpsert`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api properties-batch-archive [options]` + +- What: Archive a batch of properties +- Call: `POST /crm/properties/2026-03/{objectType}/batch/archive`, effect: destructive +- Permission keys: `fields.delete` +- Body: `BatchInputPropertyName`, required + +| Flag | Required | What | +|---|---|---| +| `--object-type ` | yes | The type of object whose properties are to be archived. This is a required parameter and identifies the specific object type within HubSpot. | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api properties-batch-create [options]` + +- What: Create a batch of properties +- Call: `POST /crm/properties/2026-03/{objectType}/batch/create`, effect: write +- Body: `BatchInputPropertyCreate`, required + +| Flag | Required | What | +|---|---|---| +| `--object-type ` | yes | The type of CRM object for which the properties are being created, such as contacts, companies, or deals. | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api properties-batch-read [options]` + +- What: Read a batch of properties +- Call: `POST /crm/properties/2026-03/{objectType}/batch/read`, effect: write +- Body: `BatchReadInputPropertyName`, required + +| Flag | Required | What | +|---|---|---| +| `--object-type ` | yes | The type of CRM object for which properties are being retrieved. This is a required path parameter. | +| `--locale ` | no | A string specifying the locale to use for the response. This can be used to tailor the response to a specific language or region. | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api tasks-batch-archive [options]` + +- What: Archive a batch of tasks by ID +- Call: `POST /crm/objects/2026-03/tasks/batch/archive`, effect: destructive +- Permission keys: `tasks.delete` +- Body: `BatchInputSimplePublicObjectId`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api tasks-batch-create [options]` + +- What: Create a batch of tasks +- Call: `POST /crm/objects/2026-03/tasks/batch/create`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInputForCreate`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api tasks-batch-read [options]` + +- What: Read a batch of tasks by internal ID, or unique property values +- Call: `POST /crm/objects/2026-03/tasks/batch/read`, effect: write +- Body: `BatchReadInputSimplePublicObjectId`, required + +| Flag | Required | What | +|---|---|---| +| `--archived ` | no | Whether to return only results that have been archived. | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api tasks-batch-update [options]` + +- What: Update a batch of tasks by internal ID, or unique property values +- Call: `POST /crm/objects/2026-03/tasks/batch/update`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInput`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api tasks-batch-upsert [options]` + +- What: Create or update a batch of tasks by unique property values +- Call: `POST /crm/objects/2026-03/tasks/batch/upsert`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInputUpsert`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api tickets-batch-archive [options]` + +- What: Archive a batch of tickets by ID +- Call: `POST /crm/objects/2026-03/tickets/batch/archive`, effect: destructive +- Permission keys: `tickets.delete` +- Body: `BatchInputSimplePublicObjectId`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api tickets-batch-create [options]` + +- What: Create a batch of tickets +- Call: `POST /crm/objects/2026-03/tickets/batch/create`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInputForCreate`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api tickets-batch-read [options]` + +- What: Read a batch of tickets by internal ID, or unique property values +- Call: `POST /crm/objects/2026-03/tickets/batch/read`, effect: write +- Body: `BatchReadInputSimplePublicObjectId`, required + +| Flag | Required | What | +|---|---|---| +| `--archived ` | no | Whether to return only results that have been archived. | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api tickets-batch-update [options]` + +- What: Update a batch of tickets by internal ID, or unique property values +- Call: `POST /crm/objects/2026-03/tickets/batch/update`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInput`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | + +## `hubspot api tickets-batch-upsert [options]` + +- What: Create or update a batch of tickets by unique property values +- Call: `POST /crm/objects/2026-03/tickets/batch/upsert`, effect: write +- Body: `BatchInputSimplePublicObjectBatchInputUpsert`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | diff --git a/skills/hubspot-cli/references/api/api-comments.md b/skills/hubspot-cli/references/api/api-comments.md deleted file mode 100644 index f7e407c..0000000 --- a/skills/hubspot-cli/references/api/api-comments.md +++ /dev/null @@ -1,57 +0,0 @@ - - -# Example Comments API: Comments - -## `hubspot api comments-create [options]` - -- What: Create a comment -- Call: `POST /comments`, effect: write -- Body: `NewComment`, required - -| Flag | Required | What | -|---|---|---| -| `--body ` | no | the request body as JSON; - reads it from stdin | -| `--body-file ` | no | the request body from a JSON file; - is stdin | - -## `hubspot api comments-delete [options]` - -- What: Delete a comment -- Call: `DELETE /comments/{comment_id}`, effect: destructive -- Permission keys: `comments.delete` - -| Flag | Required | What | -|---|---|---| -| `--comment-id ` | yes | comment\_id | - -## `hubspot api comments-get [options]` - -- What: Show one comment -- Call: `GET /comments/{comment_id}`, effect: read - -| Flag | Required | What | -|---|---|---| -| `--comment-id ` | yes | comment\_id | - -## `hubspot api comments-list [options]` - -- What: List comments, newest first -- Call: `GET /comments`, effect: read -- Pages: cursor: send `start_cursor` (query), read the next one from `next_cursor`; items in `results`; `has_more` is false on the last page; page size in `limit` (query) - -| Flag | Required | What | -|---|---|---| -| `--limit ` | no | limit | -| `--start-cursor ` | no | start\_cursor | -| `--all` | no | read every page, as the API pages it | - -## `hubspot api comments-update [options]` - -- What: Change a comment's text -- Call: `PATCH /comments/{comment_id}`, effect: write -- Body: `NewComment`, required - -| Flag | Required | What | -|---|---|---| -| `--comment-id ` | yes | comment\_id | -| `--body ` | no | the request body as JSON; - reads it from stdin | -| `--body-file ` | no | the request body from a JSON file; - is stdin | diff --git a/skills/hubspot-cli/references/api/api-search.md b/skills/hubspot-cli/references/api/api-search.md new file mode 100644 index 0000000..b6eda85 --- /dev/null +++ b/skills/hubspot-cli/references/api/api-search.md @@ -0,0 +1,147 @@ + + +# Example Comments API: Search + +## `hubspot api calls-search [options]` + +- What: Search for calls +- Call: `POST /crm/objects/2026-03/calls/search`, effect: read +- Pages: cursor: send `after` (body), read the next one from `paging.next.after`; items in `results`; page size in `limit` (body) +- Body: `PublicObjectSearchRequest`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | +| `--all` | no | read every page, as the API pages it | + +## `hubspot api companies-search [options]` + +- What: Search for companies +- Call: `POST /crm/objects/2026-03/companies/search`, effect: read +- Pages: cursor: send `after` (body), read the next one from `paging.next.after`; items in `results`; page size in `limit` (body) +- Body: `PublicObjectSearchRequest`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | +| `--all` | no | read every page, as the API pages it | + +## `hubspot api contacts-search [options]` + +- What: Search for contacts +- Call: `POST /crm/objects/2026-03/contacts/search`, effect: read +- Pages: cursor: send `after` (body), read the next one from `paging.next.after`; items in `results`; page size in `limit` (body) +- Body: `PublicObjectSearchRequest`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | +| `--all` | no | read every page, as the API pages it | + +## `hubspot api deals-search [options]` + +- What: Search for deals using various filters and criteria to retrieve specific records. +- Call: `POST /crm/objects/2026-03/0-3/search`, effect: read +- Pages: cursor: send `after` (body), read the next one from `paging.next.after`; items in `results`; page size in `limit` (body) +- Body: `PublicObjectSearchRequest`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | +| `--all` | no | read every page, as the API pages it | + +## `hubspot api emails-search [options]` + +- What: Search for emails using specified criteria and filters. +- Call: `POST /crm/objects/2026-03/emails/search`, effect: read +- Pages: cursor: send `after` (body), read the next one from `paging.next.after`; items in `results`; page size in `limit` (body) +- Body: `PublicObjectSearchRequest`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | +| `--all` | no | read every page, as the API pages it | + +## `hubspot api leads-search [options]` + +- What: Search for leads using specified criteria. +- Call: `POST /crm/objects/2026-03/leads/search`, effect: read +- Pages: cursor: send `after` (body), read the next one from `paging.next.after`; items in `results`; page size in `limit` (body) +- Body: `PublicObjectSearchRequest`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | +| `--all` | no | read every page, as the API pages it | + +## `hubspot api meetings-search [options]` + +- What: Search for meetings +- Call: `POST /crm/objects/2026-03/meetings/search`, effect: read +- Pages: cursor: send `after` (body), read the next one from `paging.next.after`; items in `results`; page size in `limit` (body) +- Body: `PublicObjectSearchRequest`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | +| `--all` | no | read every page, as the API pages it | + +## `hubspot api notes-search [options]` + +- What: Search for notes based on specified criteria. +- Call: `POST /crm/objects/2026-03/notes/search`, effect: read +- Pages: cursor: send `after` (body), read the next one from `paging.next.after`; items in `results`; page size in `limit` (body) +- Body: `PublicObjectSearchRequest`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | +| `--all` | no | read every page, as the API pages it | + +## `hubspot api search [options]` + +- What: post-/crm/objects/2026-03/{objectType}/search_/crm/objects/2025-09/{objectType}/search +- Call: `POST /crm/objects/2026-03/{objectType}/search`, effect: read +- Pages: cursor: send `after` (body), read the next one from `paging.next.after`; items in `results`; page size in `limit` (body) +- Body: `PublicObjectSearchRequest`, required + +| Flag | Required | What | +|---|---|---| +| `--object-type ` | yes | objectType | +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | +| `--all` | no | read every page, as the API pages it | + +## `hubspot api tasks-search [options]` + +- What: Search for tasks using specified criteria. +- Call: `POST /crm/objects/2026-03/tasks/search`, effect: read +- Pages: cursor: send `after` (body), read the next one from `paging.next.after`; items in `results`; page size in `limit` (body) +- Body: `PublicObjectSearchRequest`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | +| `--all` | no | read every page, as the API pages it | + +## `hubspot api tickets-search [options]` + +- What: Search for tickets +- Call: `POST /crm/objects/2026-03/tickets/search`, effect: read +- Pages: cursor: send `after` (body), read the next one from `paging.next.after`; items in `results`; page size in `limit` (body) +- Body: `PublicObjectSearchRequest`, required + +| Flag | Required | What | +|---|---|---| +| `--body ` | no | the request body as JSON; - reads it from stdin | +| `--body-file ` | no | the request body from a JSON file; - is stdin | +| `--all` | no | read every page, as the API pages it | diff --git a/spec/hubspot/account-info.json b/spec/hubspot/account-info.json new file mode 100644 index 0000000..22fbc64 --- /dev/null +++ b/spec/hubspot/account-info.json @@ -0,0 +1,327 @@ +{ + "openapi" : "3.0.1", + "info" : { + "title" : "Account Account Info", + "description" : "Basepom for all HubSpot Projects", + "version" : "2026-03", + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + } + }, + "servers" : [ { + "url" : "https://api.hubapi.com" + } ], + "tags" : [ { + "name" : "Basic" + } ], + "paths" : { + "/account-info/2026-03/api-usage/daily/private-apps" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Retrieve private app daily API usage", + "description" : "Retrieve the daily API usage for private apps in the account, along with information about usage limits.", + "operationId" : "get-/account-info/2026-03/api-usage/daily/private-apps_/account-info/2025-09/api-usage/daily/private-apps", + "parameters" : [ ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponseApiUsageNoPaging" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "oauth" ] + } ] + } + }, + "/account-info/2026-03/details" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Retrieve account details", + "description" : "Retrieve account details such as the account type, time zone, currencies, and data hosting location. ", + "operationId" : "get-/account-info/2026-03/details_/account-info/2025-09/details", + "parameters" : [ ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PortalInformationResponse" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + } + }, + "components" : { + "schemas" : { + "ApiUsage" : { + "required" : [ "collectedAt", "currentUsage", "fetchStatus", "name", "usageLimit" ], + "type" : "object", + "properties" : { + "collectedAt" : { + "type" : "string", + "description" : "Indicates when the cache was last updated.", + "format" : "date-time" + }, + "currentUsage" : { + "type" : "integer", + "description" : "How many API calls an account has made for the current day.", + "format" : "int32" + }, + "fetchStatus" : { + "type" : "string", + "description" : "Status of fetching the information, including if the data came from the cache.", + "enum" : [ "CACHED", "FAILURE", "NOTFOUND", "SUCCESS", "TIMEOUT" ] + }, + "name" : { + "type" : "string", + "description" : "Name of the limit type." + }, + "resetsAt" : { + "type" : "string", + "description" : "Time that the limit will reset.", + "format" : "date-time" + }, + "usageLimit" : { + "type" : "integer", + "description" : "Limits by which a single integration can consume the HubSpot public APIs.", + "format" : "int32" + } + } + }, + "CollectionResponseApiUsageNoPaging" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ApiUsage" + } + } + } + }, + "Error" : { + "required" : [ "category", "correlationId", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The error category" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}" + }, + "correlationId" : { + "type" : "string", + "description" : "A unique identifier for the request. Include this value with any error reports or support tickets", + "format" : "uuid", + "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf" + }, + "errors" : { + "type" : "array", + "description" : "further information about the error", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps" + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate", + "example" : "An error occurred" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered.", + "example" : { + "message" : "Invalid input (details will vary based on the error)", + "correlationId" : "aeb5f871-7f07-4993-9211-075dc63e7cbf", + "category" : "VALIDATION_ERROR", + "links" : { + "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base" + } + } + }, + "ErrorDetail" : { + "required" : [ "message" ], + "type" : "object", + "properties" : { + "code" : { + "type" : "string", + "description" : "The status code associated with the error detail" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{missingScopes=[scope1, scope2]}" + }, + "in" : { + "type" : "string", + "description" : "The name of the field or parameter in which the error was found." + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response." + }, + "PortalInformationResponse" : { + "required" : [ "accountType", "additionalCurrencies", "companyCurrency", "dataHostingLocation", "portalId", "timeZone", "uiDomain", "utcOffset", "utcOffsetMilliseconds" ], + "type" : "object", + "properties" : { + "accountType" : { + "type" : "string", + "description" : "The type of account, such as APP_DEVELOPER, DEVELOPER_TEST, SANDBOX, or STANDARD.", + "enum" : [ "APP_DEVELOPER", "DEVELOPER_TEST", "SANDBOX", "STANDARD" ] + }, + "additionalCurrencies" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "companyCurrency" : { + "type" : "string", + "description" : "The primary currency used by the company." + }, + "dataHostingLocation" : { + "type" : "string", + "description" : "The location where the account's data is hosted." + }, + "portalId" : { + "type" : "integer", + "description" : "The unique identifier for the HubSpot account.", + "format" : "int32" + }, + "timeZone" : { + "type" : "string", + "description" : "The time zone in which the account operates." + }, + "uiDomain" : { + "type" : "string", + "description" : "The domain used for accessing the HubSpot user interface." + }, + "utcOffset" : { + "type" : "string", + "description" : "The time zone offset from UTC in hours and minutes." + }, + "utcOffsetMilliseconds" : { + "type" : "integer", + "description" : "The time zone offset from UTC in milliseconds.", + "format" : "int64" + } + } + } + }, + "responses" : { + "Error" : { + "description" : "An error occurred.", + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + } + } + } + }, + "securitySchemes" : { + "developer_hapikey" : { + "type" : "apiKey", + "name" : "hapikey", + "in" : "query" + }, + "oauth2" : { + "type" : "oauth2", + "flows" : { + "authorizationCode" : { + "authorizationUrl" : "https://app.hubspot.com/oauth/authorize", + "tokenUrl" : "https://api.hubapi.com/oauth/v1/token", + "scopes" : { + "account-info.security.read" : "", + "oauth" : "" + } + } + }, + "x-hubspot-app-availability" : { + "account-info.security.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "oauth" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + } + } + } + } + }, + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + } +} \ No newline at end of file diff --git a/spec/hubspot/associations.json b/spec/hubspot/associations.json new file mode 100644 index 0000000..af0e0ed --- /dev/null +++ b/spec/hubspot/associations.json @@ -0,0 +1,4272 @@ +{ + "openapi" : "3.0.1", + "info" : { + "title" : "Associations", + "description" : "Basepom for all HubSpot Projects", + "version" : "2026-03", + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + }, + "x-hubspot-api-use-case" : "When an existing contact has moved to a new company, update their associated company to keep your CRM up to date.", + "x-hubspot-introduction" : "Use the associations API to create, retrieve, update, or delete associations between records, or between records and activities. " + }, + "servers" : [ { + "url" : "https://api.hubapi.com" + } ], + "tags" : [ { + "name" : "Basic" + }, { + "name" : "Batch" + }, { + "name" : "Search" + } ], + "paths" : { + "/crm/associations/2026-03/usage/high-usage-report/{userId}" : { + "post" : { + "tags" : [ "Basic" ], + "summary" : "Report high usage", + "description" : "Requests a report of all objects in the portal which have a high usage of associations", + "operationId" : "post-/crm/associations/2026-03/usage/high-usage-report/{userId}_/crm/associations/2025-09/usage/high-usage-report/{userId}", + "parameters" : [ { + "name" : "userId", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "integer", + "format" : "int32" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ReportCreationResponse" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + } ], + "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ] + } + }, + "/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/archive" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Remove associations", + "description" : "Batch delete associations for objects", + "operationId" : "post-/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/archive_/crm/associations/2025-09/{fromObjectType}/{toObjectType}/batch/archive", + "parameters" : [ { + "name" : "fromObjectType", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputPublicAssociationMultiArchive" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponse" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + } ], + "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ] + } + }, + "/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/associate/default" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : " Create Default Associations", + "description" : "Create the default (most generic) association type between two object types", + "operationId" : "post-/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/associate/default_/crm/associations/2025-09/{fromObjectType}/{toObjectType}/batch/associate/default", + "parameters" : [ { + "name" : "fromObjectType", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputPublicDefaultAssociationMultiPost" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponsePublicDefaultAssociation" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + } ], + "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ] + } + }, + "/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/create" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Associate records (labelled)", + "description" : "Batch create associations for objects", + "operationId" : "post-/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/create_/crm/associations/2025-09/{fromObjectType}/{toObjectType}/batch/create", + "parameters" : [ { + "name" : "fromObjectType", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputPublicAssociationMultiPost" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseLabelsBetweenObjectPair" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseLabelsBetweenObjectPairWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + } ], + "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ] + } + }, + "/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/labels/archive" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Delete Specific Labels", + "description" : "Batch delete specific association labels for objects. Deleting an unlabeled association will also delete all labeled associations between those two objects", + "operationId" : "post-/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/labels/archive_/crm/associations/2025-09/{fromObjectType}/{toObjectType}/batch/labels/archive", + "parameters" : [ { + "name" : "fromObjectType", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputPublicAssociationMultiPost" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponse" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + } ], + "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ] + } + }, + "/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/read" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Retrieve associations", + "description" : "Batch read associations for objects to specific object type. The 'after' field in a returned paging object can be added alongside the 'id' to retrieve the next page of associations from that objectId. The 'link' field is deprecated and should be ignored. Note: The 'paging' field will only be present if there are more pages and absent otherwise.", + "operationId" : "post-/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/read_/crm/associations/2025-09/{fromObjectType}/{toObjectType}/batch/read", + "parameters" : [ { + "name" : "fromObjectType", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputPublicFetchAssociationsBatchRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponsePublicAssociationMultiWithLabel" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponsePublicAssociationMultiWithLabelWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + } ], + "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ] + } + }, + "/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}" : { + "put" : { + "tags" : [ "Batch" ], + "summary" : "Associate records (default)", + "description" : "Create the default (most generic) association type between two object types", + "operationId" : "put-/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}_/crm/objects/2025-09/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "fromObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "fromObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponsePublicDefaultAssociation" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/{objectType}/search" : { + "post" : { + "tags" : [ "Search" ], + "summary" : "", + "description" : "", + "operationId" : "post-/crm/objects/2026-03/{objectType}/search_/crm/objects/2025-09/{objectType}/search", + "parameters" : [ { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PublicObjectSearchRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponseWithTotalSimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Retrieve all associations by object type", + "description" : "Retrieve all associations between a specific record and an object type. Limit 500 per call.", + "operationId" : "get-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}_/crm/objects/2025-09/{objectType}/{objectId}/associations/{toObjectType}", + "parameters" : [ { + "name" : "objectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "after", + "in" : "query", + "description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum number of results to display per page.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 500 + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponseMultiAssociatedObjectWithLabelForwardPaging" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}" : { + "put" : { + "tags" : [ "Basic" ], + "summary" : "Associate records (labelled)", + "description" : "Set association labels between two records.", + "operationId" : "put-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2025-09/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "objectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AssociationSpec" + } + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "headers" : { + "Location" : { + "description" : "URL of the newly created resource", + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LabelsBetweenObjectPair" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "delete" : { + "tags" : [ "Basic" ], + "summary" : "Delete associations between two records", + "description" : "deletes all associations between two records.", + "operationId" : "delete-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2025-09/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "objectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : true + } + } + } + }, + "components" : { + "schemas" : { + "AssociationSpec" : { + "required" : [ "associationCategory", "associationTypeId" ], + "type" : "object", + "properties" : { + "associationCategory" : { + "type" : "string", + "description" : "The category of the association, such as \"HUBSPOT_DEFINED\".", + "enum" : [ "HUBSPOT_DEFINED", "INTEGRATOR_DEFINED", "USER_DEFINED", "WORK" ] + }, + "associationTypeId" : { + "type" : "integer", + "description" : "The ID representing the specific type of association.", + "format" : "int32" + } + }, + "description" : "Defines the type, direction, and details of the relationship between two CRM objects." + }, + "AssociationSpecWithLabel" : { + "required" : [ "category", "typeId" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The category of the association, such as HUBSPOT_DEFINED, USER_DEFINED, or INTEGRATOR_DEFINED.", + "enum" : [ "HUBSPOT_DEFINED", "INTEGRATOR_DEFINED", "USER_DEFINED", "WORK" ] + }, + "fromObjectTypeId" : { + "type" : "string" + }, + "label" : { + "type" : "string", + "description" : "A label describing the association between two objects." + }, + "toObjectTypeId" : { + "type" : "string" + }, + "typeId" : { + "type" : "integer", + "description" : "The unique identifier for the type of association.", + "format" : "int32" + } + }, + "description" : "Defines the type, direction, and details of the relationship between two CRM objects." + }, + "BatchInputPublicAssociationMultiArchive" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicAssociationMultiArchive" + } + } + } + }, + "BatchInputPublicAssociationMultiPost" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicAssociationMultiPost" + } + } + } + }, + "BatchInputPublicDefaultAssociationMultiPost" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicDefaultAssociationMultiPost" + } + } + } + }, + "BatchInputPublicFetchAssociationsBatchRequest" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicFetchAssociationsBatchRequest" + } + } + } + }, + "BatchResponse" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "numErrors" : { + "type" : "integer", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { } + } + }, + "startedAt" : { + "type" : "string", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + } + }, + "BatchResponseLabelsBetweenObjectPair" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch request was initially made, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LabelsBetweenObjectPair" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing began, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request: \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + } + }, + "BatchResponseLabelsBetweenObjectPairWithErrors" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "numErrors" : { + "type" : "integer", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LabelsBetweenObjectPair" + } + }, + "startedAt" : { + "type" : "string", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + } + }, + "BatchResponsePublicAssociationMultiWithLabel" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch request was initially made, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicAssociationMultiWithLabel" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing began, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request: \"PENDING\", \"PROCESSING\", \"CANCELED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + } + }, + "BatchResponsePublicAssociationMultiWithLabelWithErrors" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "numErrors" : { + "type" : "integer", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicAssociationMultiWithLabel" + } + }, + "startedAt" : { + "type" : "string", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + } + }, + "BatchResponsePublicDefaultAssociation" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "description" : "An array of StandardError objects detailing any errors that occurred during the batch operation.", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "numErrors" : { + "type" : "integer", + "description" : "The number of errors encountered during the batch processing.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of PublicDefaultAssociation objects representing the results of the batch operation.", + "items" : { + "$ref" : "#/components/schemas/PublicDefaultAssociation_1" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request: \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "The response returned after performing a batch operation on associations." + }, + "CollectionResponseMultiAssociatedObjectWithLabelForwardPaging" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/ForwardPaging" + }, + "results" : { + "type" : "array", + "description" : "The list of objects that are associated with multiple labels, returned as part of the collection.", + "items" : { + "$ref" : "#/components/schemas/MultiAssociatedObjectWithLabel" + } + } + }, + "description" : "Represents a paginated collection of objects that are associated with multiple labels, including the results and pagination details. This component is used when retrieving associated objects with specific labels in a forward-paging manner." + }, + "CollectionResponseWithTotalSimplePublicObject" : { + "required" : [ "results", "total" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/Paging" + }, + "results" : { + "type" : "array", + "description" : "An array containing the simple public objects returned in the current page of the response. This property is required.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "total" : { + "type" : "integer", + "description" : "The total number of objects in the collection.", + "format" : "int32" + } + }, + "description" : "Represents a list of simple objects returned from an API request, along with the total count of objects available." + }, + "DateTime" : { + "required" : [ "dateOnly", "timeZoneShift", "value" ], + "type" : "object", + "properties" : { + "dateOnly" : { + "type" : "boolean", + "description" : "Indicates whether the DateTime value represents only a date without a time component." + }, + "timeZoneShift" : { + "type" : "integer", + "description" : "The integer value representing the shift in minutes from UTC for the DateTime value.", + "format" : "int32" + }, + "value" : { + "type" : "integer", + "description" : "The integer value representing a specific point in time.", + "format" : "int64" + } + } + }, + "Error" : { + "required" : [ "category", "correlationId", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The error category" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}" + }, + "correlationId" : { + "type" : "string", + "description" : "A unique identifier for the request. Include this value with any error reports or support tickets", + "format" : "uuid", + "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf" + }, + "errors" : { + "type" : "array", + "description" : "further information about the error", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps" + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate", + "example" : "An error occurred" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered.", + "example" : { + "message" : "Invalid input (details will vary based on the error)", + "correlationId" : "aeb5f871-7f07-4993-9211-075dc63e7cbf", + "category" : "VALIDATION_ERROR", + "links" : { + "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base" + } + } + }, + "ErrorDetail" : { + "required" : [ "message" ], + "type" : "object", + "properties" : { + "code" : { + "type" : "string", + "description" : "The status code associated with the error detail" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{missingScopes=[scope1, scope2]}" + }, + "in" : { + "type" : "string", + "description" : "The name of the field or parameter in which the error was found." + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response." + }, + "Filter" : { + "required" : [ "operator", "propertyName" ], + "type" : "object", + "properties" : { + "highValue" : { + "type" : "string", + "description" : "The upper boundary value when using ranged-based filters." + }, + "operator" : { + "type" : "string", + "description" : "The comparison operator used in the filter, such as \"EQ\" or \"GT\".", + "enum" : [ "BETWEEN", "CONTAINS_TOKEN", "EQ", "GT", "GTE", "HAS_PROPERTY", "IN", "LT", "LTE", "NEQ", "NOT_CONTAINS_TOKEN", "NOT_HAS_PROPERTY", "NOT_IN" ] + }, + "propertyName" : { + "type" : "string", + "description" : "The name of the property to apply the filter to." + }, + "value" : { + "type" : "string", + "description" : "The value to match against the property." + }, + "values" : { + "type" : "array", + "description" : "The values to match against the property.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against. " + }, + "FilterGroup" : { + "required" : [ "filters" ], + "type" : "object", + "properties" : { + "filters" : { + "type" : "array", + "description" : "A list of individual filter criteria that are applied together as a group. Each filter specifies a condition that records must meet to be included in the results.", + "items" : { + "$ref" : "#/components/schemas/Filter" + } + } + }, + "description" : "Represents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints." + }, + "ForwardPaging" : { + "type" : "object", + "properties" : { + "next" : { + "$ref" : "#/components/schemas/NextPage" + } + }, + "description" : "Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page." + }, + "LabelsBetweenObjectPair" : { + "required" : [ "fromObjectId", "fromObjectTypeId", "labels", "toObjectId", "toObjectTypeId" ], + "type" : "object", + "properties" : { + "fromObjectId" : { + "type" : "string", + "description" : "The ID of the source object in the association." + }, + "fromObjectTypeId" : { + "type" : "string", + "description" : "The type ID of the source object in the association." + }, + "labels" : { + "type" : "array", + "description" : "An array of labels associated with the relationship between the objects.", + "items" : { + "type" : "string" + } + }, + "toObjectId" : { + "type" : "string", + "description" : "The ID of the target object in the association." + }, + "toObjectTypeId" : { + "type" : "string", + "description" : "The type ID of the target object in the association." + } + }, + "description" : "The relationship descriptors applicable between two object types." + }, + "MultiAssociatedObjectWithLabel" : { + "required" : [ "associationTypes", "toObjectId" ], + "type" : "object", + "properties" : { + "associationTypes" : { + "type" : "array", + "description" : "An array of association types that define the relationships between this object and other objects. This property is required.", + "items" : { + "$ref" : "#/components/schemas/AssociationSpecWithLabel" + } + }, + "toObjectId" : { + "type" : "string", + "description" : "The unique identifier for the target object in the association." + } + }, + "description" : "Represents an object that is associated with multiple other objects, with optional context." + }, + "NextPage" : { + "required" : [ "after" ], + "type" : "object", + "properties" : { + "after" : { + "type" : "string", + "description" : "A paging cursor token for retrieving subsequent pages." + }, + "link" : { + "type" : "string", + "description" : "A URL that can be used to retrieve the next page results." + } + }, + "description" : "Specifies the paging information needed to retrieve the next set of results in a paginated API response" + }, + "Paging" : { + "type" : "object", + "properties" : { + "next" : { + "$ref" : "#/components/schemas/NextPage" + }, + "prev" : { + "$ref" : "#/components/schemas/PreviousPage" + } + }, + "description" : "Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results." + }, + "Paging_1" : { + "type" : "object", + "properties" : { + "next" : { + "$ref" : "#/components/schemas/NextPage" + }, + "prev" : { + "$ref" : "#/components/schemas/PreviousPage" + } + }, + "description" : "Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results." + }, + "PreviousPage" : { + "required" : [ "before" ], + "type" : "object", + "properties" : { + "before" : { + "type" : "string", + "description" : "A paging cursor token for retrieving previous pages." + }, + "link" : { + "type" : "string", + "description" : "A URL that can be used to retrieve the previous pages' results." + } + }, + "description" : "specifies the paging information needed to retrieve the previous set of results in a paginated API response" + }, + "PublicAssociationMultiArchive" : { + "required" : [ "from", "to" ], + "type" : "object", + "properties" : { + "from" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "to" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectId" + } + } + } + }, + "PublicAssociationMultiPost" : { + "required" : [ "from", "to", "types" ], + "type" : "object", + "properties" : { + "from" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "to" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "types" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AssociationSpec" + } + } + } + }, + "PublicAssociationMultiWithLabel" : { + "required" : [ "from", "to" ], + "type" : "object", + "properties" : { + "from" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "paging" : { + "$ref" : "#/components/schemas/Paging_1" + }, + "to" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MultiAssociatedObjectWithLabel" + } + } + } + }, + "PublicDefaultAssociationMultiPost" : { + "required" : [ "from", "to" ], + "type" : "object", + "properties" : { + "from" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "to" : { + "$ref" : "#/components/schemas/PublicObjectId" + } + } + }, + "PublicDefaultAssociation_1" : { + "required" : [ "associationSpec", "from", "to" ], + "type" : "object", + "properties" : { + "associationSpec" : { + "$ref" : "#/components/schemas/AssociationSpec" + }, + "from" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "to" : { + "$ref" : "#/components/schemas/PublicObjectId" + } + }, + "description" : "The PublicDefaultAssociation component represents the default association configuration between two objects in HubSpot. It is used to define how objects are related to each other within the platform." + }, + "PublicFetchAssociationsBatchRequest" : { + "required" : [ "id" ], + "type" : "object", + "properties" : { + "after" : { + "type" : "string", + "description" : "A paging cursor token used to retrieve the next set of results in a paginated response." + }, + "id" : { + "type" : "string", + "description" : "The unique identifier for the object whose associations are being fetched." + } + } + }, + "PublicObjectId" : { + "required" : [ "id" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "ID of the object" + } + }, + "description" : "Contains the Id of a Public Object" + }, + "PublicObjectSearchRequest" : { + "required" : [ "after", "filterGroups", "limit", "properties", "sorts" ], + "type" : "object", + "properties" : { + "after" : { + "type" : "string", + "description" : "A paging cursor token for retrieving subsequent pages." + }, + "filterGroups" : { + "type" : "array", + "description" : "Up to 6 groups of filters defining additional query criteria.", + "items" : { + "$ref" : "#/components/schemas/FilterGroup" + } + }, + "limit" : { + "type" : "integer", + "description" : "The maximum results to return, up to 200 objects.", + "format" : "int32" + }, + "properties" : { + "type" : "array", + "description" : "A list of property names to include in the response.", + "items" : { + "type" : "string" + } + }, + "query" : { + "type" : "string", + "description" : "The search query string, up to 3000 characters." + }, + "sorts" : { + "type" : "array", + "description" : "Specifies sorting order based on object properties.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Describes a search request" + }, + "PublicObjectWarning" : { + "required" : [ "category", "context", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The classification of the warning, indicating the type or nature of the issue." + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Additional information or metadata about the warning, providing context for understanding the issue." + }, + "message" : { + "type" : "string", + "description" : "The text of the warning message, providing information about the issue or alert." + } + }, + "description" : "Represents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning." + }, + "ReportCreationResponse" : { + "required" : [ "enqueueTime", "userEmail", "userId" ], + "type" : "object", + "properties" : { + "enqueueTime" : { + "$ref" : "#/components/schemas/DateTime" + }, + "userEmail" : { + "type" : "string", + "description" : "Email of the user" + }, + "userId" : { + "type" : "integer", + "description" : "ID of the user", + "format" : "int32" + } + } + }, + "SimplePublicObject" : { + "required" : [ "archived", "createdAt", "id", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "A unique identifier for tracing the creation request." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL associated with the object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "A simple public object." + }, + "StandardError" : { + "required" : [ "category", "context", "errors", "links", "message", "status" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The main category of the error." + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Additional context-specific information related to the error." + }, + "errors" : { + "type" : "array", + "description" : "The detailed error objects.", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "id" : { + "type" : "string", + "description" : "A unique ID for the error instance." + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "URLs linking to documentation or resources associated with the error." + }, + "message" : { + "type" : "string", + "description" : "A human-readable string describing the error and possible remediation steps." + }, + "status" : { + "type" : "string", + "description" : "The HTTP status code associated with the error." + }, + "subCategory" : { + "type" : "object", + "properties" : { }, + "description" : "A more specific error category within each main category." + } + }, + "description" : "Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request." + }, + "ValueWithTimestamp" : { + "required" : [ "sourceType", "timestamp", "value" ], + "type" : "object", + "properties" : { + "sourceId" : { + "type" : "string", + "description" : "The unique ID of the property." + }, + "sourceLabel" : { + "type" : "string", + "description" : "A human-readable label." + }, + "sourceType" : { + "type" : "string", + "description" : "The property type." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp when the property was updated, in ISO 8601 format.", + "format" : "date-time" + }, + "updatedByUserId" : { + "type" : "integer", + "description" : "The ID of the user who last updated the property.", + "format" : "int32" + }, + "value" : { + "type" : "string", + "description" : "The property value." + } + }, + "description" : "Property model that includes timestamp." + } + }, + "responses" : { + "Error" : { + "description" : "An error occurred.", + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + } + } + } + }, + "securitySchemes" : { + "developer_hapikey" : { + "type" : "apiKey", + "name" : "hapikey", + "in" : "query" + }, + "oauth2" : { + "type" : "oauth2", + "flows" : { + "authorizationCode" : { + "authorizationUrl" : "https://app.hubspot.com/oauth/authorize", + "tokenUrl" : "https://api.hubapi.com/oauth/v1/token", + "scopes" : { + "cpq.price_books.read" : "", + "crm.objects.appointments.read" : "", + "crm.objects.appointments.sensitive.read.v2" : "", + "crm.objects.appointments.sensitive.write.v2" : "", + "crm.objects.appointments.write" : "", + "crm.objects.calls.read" : "", + "crm.objects.calls.write" : "", + "crm.objects.carts.read" : "", + "crm.objects.carts.write" : "", + "crm.objects.commercepayments.read" : "", + "crm.objects.commercepayments.write" : "", + "crm.objects.companies.highly_sensitive.read.v2" : "", + "crm.objects.companies.highly_sensitive.write.v2" : "", + "crm.objects.companies.read" : "", + "crm.objects.companies.sensitive.read.v2" : "", + "crm.objects.companies.sensitive.write.v2" : "", + "crm.objects.companies.write" : "", + "crm.objects.contacts.highly_sensitive.read.v2" : "", + "crm.objects.contacts.highly_sensitive.write.v2" : "", + "crm.objects.contacts.read" : "", + "crm.objects.contacts.sensitive.read.v2" : "", + "crm.objects.contacts.sensitive.write.v2" : "", + "crm.objects.contacts.write" : "", + "crm.objects.contracts.read" : "", + "crm.objects.courses.read" : "", + "crm.objects.courses.write" : "", + "crm.objects.custom.highly_sensitive.read.v2" : "", + "crm.objects.custom.highly_sensitive.write.v2" : "", + "crm.objects.custom.read" : "", + "crm.objects.custom.sensitive.read.v2" : "", + "crm.objects.custom.sensitive.write.v2" : "", + "crm.objects.custom.write" : "", + "crm.objects.deals.highly_sensitive.read.v2" : "", + "crm.objects.deals.highly_sensitive.write.v2" : "", + "crm.objects.deals.read" : "", + "crm.objects.deals.sensitive.read.v2" : "", + "crm.objects.deals.sensitive.write.v2" : "", + "crm.objects.deals.write" : "", + "crm.objects.emails.read" : "", + "crm.objects.emails.write" : "", + "crm.objects.feedback_submissions.read" : "", + "crm.objects.forecasts.read" : "", + "crm.objects.goals.read" : "", + "crm.objects.goals.write" : "", + "crm.objects.invoices.read" : "", + "crm.objects.invoices.write" : "", + "crm.objects.leads.read" : "", + "crm.objects.leads.write" : "", + "crm.objects.line_items.read" : "", + "crm.objects.line_items.write" : "", + "crm.objects.listings.read" : "", + "crm.objects.listings.write" : "", + "crm.objects.meetings.read" : "", + "crm.objects.meetings.write" : "", + "crm.objects.notes.read" : "", + "crm.objects.notes.write" : "", + "crm.objects.orders.read" : "", + "crm.objects.orders.write" : "", + "crm.objects.partner-clients.read" : "", + "crm.objects.partner-clients.write" : "", + "crm.objects.partner-services.read" : "", + "crm.objects.partner-services.write" : "", + "crm.objects.products.read" : "", + "crm.objects.products.write" : "", + "crm.objects.projects.highly_sensitive.read" : "", + "crm.objects.projects.highly_sensitive.write" : "", + "crm.objects.projects.read" : "", + "crm.objects.projects.sensitive.read" : "", + "crm.objects.projects.sensitive.write" : "", + "crm.objects.projects.write" : "", + "crm.objects.quotes.read" : "", + "crm.objects.quotes.write" : "", + "crm.objects.services.read" : "", + "crm.objects.services.write" : "", + "crm.objects.subscriptions.read" : "", + "crm.objects.subscriptions.write" : "", + "crm.objects.tasks.read" : "", + "crm.objects.tasks.write" : "", + "crm.objects.tickets.highly_sensitive.read" : "", + "crm.objects.tickets.highly_sensitive.write" : "", + "crm.objects.tickets.read" : "", + "crm.objects.tickets.sensitive.read" : "", + "crm.objects.tickets.sensitive.write" : "", + "crm.objects.tickets.write" : "", + "crm.objects.users.read" : "", + "crm.objects.users.write" : "", + "e-commerce" : "", + "media_bridge.read" : "", + "oauth" : "", + "revenue.contracts.read" : "", + "tickets.highly_sensitive.v2" : "", + "tickets.sensitive.v2" : "" + } + } + }, + "x-hubspot-app-availability" : { + "cpq.price_books.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.appointments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.commercepayments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.commercepayments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.companies.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.contacts.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contracts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.custom.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.feedback_submissions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.forecasts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-clients.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-clients.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.products.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.products.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "e-commerce" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "media_bridge.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "revenue.contracts.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "tickets.highly_sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "tickets.sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + } + } + } + } + }, + "x-hubspot-available-client-libraries" : [ "Node", "Python", "Ruby", "PHP" ], + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + } +} \ No newline at end of file diff --git a/spec/hubspot/calls.json b/spec/hubspot/calls.json new file mode 100644 index 0000000..d98b346 --- /dev/null +++ b/spec/hubspot/calls.json @@ -0,0 +1,3106 @@ +{ + "openapi" : "3.0.1", + "info" : { + "title" : "Calls", + "description" : "Basepom for all HubSpot Projects", + "version" : "2026-03", + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + }, + "x-hubspot-api-use-case" : "If your team isn't using the HubSpot calling tool to make calls to prospects, you can use the calls API to log call information from another service to your HubSpot account.", + "x-hubspot-introduction" : "Use the call engagements API to associate calls with your CRM records. You can include key takeaways in the metadata of each call, including the call's outcome, recipient information, and a URL of the recording, if applicable." + }, + "servers" : [ { + "url" : "https://api.hubapi.com" + } ], + "tags" : [ { + "name" : "Basic" + }, { + "name" : "Batch" + }, { + "name" : "Search" + } ], + "paths" : { + "/crm/objects/2026-03/calls" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "List", + "description" : "Read a page of calls. Control what is returned via the `properties` query param.", + "operationId" : "get-/crm/objects/2026-03/calls_getPage", + "parameters" : [ { + "name" : "after", + "in" : "query", + "description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "associations", + "in" : "query", + "description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum number of results to display per page.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 10 + } + }, { + "name" : "properties", + "in" : "query", + "description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "propertiesWithHistory", + "in" : "query", + "description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponseSimplePublicObjectWithAssociationsForwardPaging" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "post" : { + "tags" : [ "Basic" ], + "summary" : "Create", + "description" : "Create a call with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard calls is provided.", + "operationId" : "post-/crm/objects/2026-03/calls_create", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectInputForCreate" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "headers" : { + "Location" : { + "description" : "URL of the newly created resource", + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/calls/batch/archive" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Archive a batch of calls by ID", + "description" : "Archive a batch of calls by ID. Deleted calls can be restored within 90 days of being deleted, but call recordings recording will be permanently deleted. Learn more about [restoring activity records](https://knowledge.hubspot.com/records/restore-deleted-activity-in-a-record).", + "operationId" : "post-/crm/objects/2026-03/calls/batch/archive_archive", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectId" + } + } + }, + "required" : true + }, + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/calls/batch/create" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Create a batch of calls", + "description" : "Create a batch of calls. The `inputs` array can contain a `properties` object to define property values for each record, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.", + "operationId" : "post-/crm/objects/2026-03/calls/batch/create_create", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputForCreate" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/calls/batch/read" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Read a batch of calls by internal ID, or unique property values", + "description" : "Retrieve a batch of calls by ID.", + "operationId" : "post-/crm/objects/2026-03/calls/batch/read_read", + "parameters" : [ { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchReadInputSimplePublicObjectId" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/calls/batch/update" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Update a batch of calls by internal ID, or unique property values", + "description" : "Update a batch of calls by ID.", + "operationId" : "post-/crm/objects/2026-03/calls/batch/update_update", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/calls/batch/upsert" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Create or update a batch of calls by unique property values", + "description" : "Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.", + "operationId" : "post-/crm/objects/2026-03/calls/batch/upsert_upsert", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputUpsert" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicUpsertObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicUpsertObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/calls/search" : { + "post" : { + "tags" : [ "Search" ], + "summary" : "Search for calls", + "description" : "Search for calls by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).", + "operationId" : "post-/crm/objects/2026-03/calls/search_doSearch", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PublicObjectSearchRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponseWithTotalSimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/calls/{callId}" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Read", + "description" : "Read an Object identified by `{callId}`. `{callId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.", + "operationId" : "get-/crm/objects/2026-03/calls/{callId}_getById", + "parameters" : [ { + "name" : "callId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + }, { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "associations", + "in" : "query", + "description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "idProperty", + "in" : "query", + "description" : "The name of a property whose values are unique for this object type", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "properties", + "in" : "query", + "description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "propertiesWithHistory", + "in" : "query", + "description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "delete" : { + "tags" : [ "Basic" ], + "summary" : "Archive", + "description" : "Move an Object identified by `{callId}` to the recycling bin.", + "operationId" : "delete-/crm/objects/2026-03/calls/{callId}_archive", + "parameters" : [ { + "name" : "callId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "patch" : { + "tags" : [ "Basic" ], + "summary" : "Update", + "description" : "Perform a partial update of an Object identified by `{callId}`or optionally a unique property value as specified by the `idProperty` query param. `{callId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + "operationId" : "patch-/crm/objects/2026-03/calls/{callId}_update", + "parameters" : [ { + "name" : "callId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + }, { + "name" : "idProperty", + "in" : "query", + "description" : "The name of a property whose values are unique for this object type", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}" : { + "put" : { + "tags" : [ "Batch" ], + "operationId" : "put-/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "fromObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "fromObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponsePublicDefaultAssociation" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}" : { + "put" : { + "tags" : [ "Basic" ], + "operationId" : "put-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "objectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AssociationSpec" + } + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "headers" : { + "Location" : { + "description" : "URL of the newly created resource", + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LabelsBetweenObjectPair" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "delete" : { + "tags" : [ "Basic" ], + "operationId" : "delete-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "objectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : true + } + } + } + }, + "components" : { + "schemas" : { + "AssociatedId" : { + "required" : [ "id", "type" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique identifier for the associated object." + }, + "type" : { + "type" : "string", + "description" : "The type of associations.", + "example" : "deal_to_contact" + } + }, + "description" : "Contains the id and type of an association" + }, + "AssociationSpec" : { + "required" : [ "associationCategory", "associationTypeId" ], + "type" : "object", + "properties" : { + "associationCategory" : { + "type" : "string", + "description" : "The category of the association, indicating its origin or purpose. Valid values include \"HUBSPOT_DEFINED\", \"USER_DEFINED\", \"INTEGRATOR_DEFINED\", and \"WORK\".", + "enum" : [ "HUBSPOT_DEFINED", "INTEGRATOR_DEFINED", "USER_DEFINED", "WORK" ] + }, + "associationTypeId" : { + "type" : "integer", + "description" : "An integer representing the unique identifier for the type of association.", + "format" : "int32" + } + }, + "description" : "Defines the type, direction, and details of the relationship between two CRM objects." + }, + "BatchInputSimplePublicObjectBatchInput" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be processed in the batch operation. Each object in the array contains the data necessary for the specific operation being performed.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInput" + } + } + }, + "description" : "Represents a batch input component used to handle multiple simple public objects in a single API request. This component is typically used when performing batch operations to create, update, or delete multiple records simultaneously." + }, + "BatchInputSimplePublicObjectBatchInputForCreate" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be created. Each object in the array contains the necessary data for creating a new entry in the system.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInputForCreate" + } + } + }, + "description" : "Represents a batch input for creating multiple simple public objects in a single request. This component is used to streamline the process of adding new objects to a HubSpot account by allowing multiple entries to be created at once." + }, + "BatchInputSimplePublicObjectBatchInputUpsert" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be upserted. Each object in the array contains the necessary data for creating or updating a record in HubSpot.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInputUpsert" + } + } + }, + "description" : "Represents a batch input operation for upserting simple public objects in HubSpot. This component is used to process multiple upsert operations in a single request, improving efficiency and performance." + }, + "BatchInputSimplePublicObjectId" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public object IDs to be processed in the batch operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectId" + } + } + }, + "description" : "Represents a batch input payload containing a list of simple public object IDs. This component is used when performing batch operations on multiple objects within HubSpot." + }, + "BatchReadInputSimplePublicObjectId" : { + "required" : [ "inputs", "properties", "propertiesWithHistory" ], + "type" : "object", + "properties" : { + "idProperty" : { + "type" : "string", + "description" : "When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID." + }, + "inputs" : { + "type" : "array", + "description" : "An array of SimplePublicObjectId objects, each containing the ID of an object to be read.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectId" + } + }, + "properties" : { + "type" : "array", + "description" : "An array of the property names to be returned in the response. If a specified property is not present on the requested object(s), it will be ignored.", + "items" : { + "type" : "string" + } + }, + "propertiesWithHistory" : { + "type" : "array", + "description" : "An array of the property names to be returned along with their history of previous values. If a specified property is not present on the requested object(s), it will be ignored.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property." + }, + "BatchResponsePublicDefaultAssociation" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "description" : "An array of StandardError objects detailing any errors that occurred during the batch operation.", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "numErrors" : { + "type" : "integer", + "description" : "The total number of errors that occurred during the operation.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of PublicDefaultAssociation objects representing the results of the batch operation.", + "items" : { + "$ref" : "#/components/schemas/PublicDefaultAssociation" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "The response returned after performing a batch operation on associations." + }, + "BatchResponseSimplePublicObject" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch request was initially made, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of SimplePublicObject items representing the results of the batch operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing began, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request: \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\"", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "A public object batch response object" + }, + "BatchResponseSimplePublicObjectWithErrors" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "numErrors" : { + "type" : "integer", + "description" : "The number of errors encountered during the batch process.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request - \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\"", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the result of a batch operation on CRM objects, including the processing status, batch results, timestamps, and a list of any errors encountered during the operation." + }, + "BatchResponseSimplePublicUpsertObject" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of SimplePublicUpsertObject items representing the results of the batch upsert operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicUpsertObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects." + }, + "BatchResponseSimplePublicUpsertObjectWithErrors" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "numErrors" : { + "type" : "integer", + "description" : "The number of errors encountered during the batch process.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SimplePublicUpsertObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the response from a batch upsert operation, including the status, timestamps, successfully processed objects, and any errors that occurred during processing." + }, + "CollectionResponseAssociatedId" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/Paging" + }, + "results" : { + "type" : "array", + "description" : "A list of associated IDs retrieved from the API request.", + "items" : { + "$ref" : "#/components/schemas/AssociatedId" + } + } + }, + "description" : "Represents a collection of associated IDs returned by an API request, including pagination details for navigating through the results." + }, + "CollectionResponseSimplePublicObjectWithAssociationsForwardPaging" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/ForwardPaging" + }, + "results" : { + "type" : "array", + "description" : "An array of simple public objects that are included in the current page of the response. Each object may include its associated data.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations" + } + } + }, + "description" : "Represents a paginated collection response that includes simple public objects with their associations. This component is used to handle the results and pagination details when retrieving a list of objects from the API." + }, + "CollectionResponseWithTotalSimplePublicObject" : { + "required" : [ "results", "total" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/Paging" + }, + "results" : { + "type" : "array", + "description" : "An array containing the simple public objects returned in the current page of the response. This property is required.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "total" : { + "type" : "integer", + "description" : "The number of available results", + "format" : "int32" + } + }, + "description" : "Represents a list of simple objects returned from an API request, along with the total count of objects available." + }, + "Error" : { + "required" : [ "category", "correlationId", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The error category" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}" + }, + "correlationId" : { + "type" : "string", + "description" : "A unique identifier for the request. Include this value with any error reports or support tickets", + "format" : "uuid", + "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf" + }, + "errors" : { + "type" : "array", + "description" : "further information about the error", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps" + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate", + "example" : "An error occurred" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered.", + "example" : { + "message" : "Invalid input (details will vary based on the error)", + "correlationId" : "aeb5f871-7f07-4993-9211-075dc63e7cbf", + "category" : "VALIDATION_ERROR", + "links" : { + "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base" + } + } + }, + "ErrorDetail" : { + "required" : [ "message" ], + "type" : "object", + "properties" : { + "code" : { + "type" : "string", + "description" : "The status code associated with the error detail" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{missingScopes=[scope1, scope2]}" + }, + "in" : { + "type" : "string", + "description" : "The name of the field or parameter in which the error was found." + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response." + }, + "Filter" : { + "required" : [ "operator", "propertyName" ], + "type" : "object", + "properties" : { + "highValue" : { + "type" : "string", + "description" : "The upper boundary value when using ranged-based filters." + }, + "operator" : { + "type" : "string", + "description" : "The comparison operator used in the filter, such as \"EQ\" or \"GT\".", + "enum" : [ "BETWEEN", "CONTAINS_TOKEN", "EQ", "GT", "GTE", "HAS_PROPERTY", "IN", "LT", "LTE", "NEQ", "NOT_CONTAINS_TOKEN", "NOT_HAS_PROPERTY", "NOT_IN" ] + }, + "propertyName" : { + "type" : "string", + "description" : "The name of the property to apply the filter to." + }, + "value" : { + "type" : "string", + "description" : "The value to match against the property." + }, + "values" : { + "type" : "array", + "description" : "The values to match against the property.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against. " + }, + "FilterGroup" : { + "required" : [ "filters" ], + "type" : "object", + "properties" : { + "filters" : { + "type" : "array", + "description" : "A list of individual filter criteria that are applied together as a group. Each filter specifies a condition that records must meet to be included in the results.", + "items" : { + "$ref" : "#/components/schemas/Filter" + } + } + }, + "description" : "Represents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints." + }, + "ForwardPaging" : { + "type" : "object", + "properties" : { + "next" : { + "$ref" : "#/components/schemas/NextPage" + } + }, + "description" : "Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page." + }, + "LabelsBetweenObjectPair" : { + "required" : [ "fromObjectId", "fromObjectTypeId", "labels", "toObjectId", "toObjectTypeId" ], + "type" : "object", + "properties" : { + "fromObjectId" : { + "type" : "string", + "description" : "Source unique ID of the object." + }, + "fromObjectTypeId" : { + "type" : "string", + "description" : "Source object type." + }, + "labels" : { + "type" : "array", + "description" : "An array of labels that describe the relationship between the two objects. This is a required property.", + "items" : { + "type" : "string" + } + }, + "toObjectId" : { + "type" : "string", + "description" : "Target unique ID of the object." + }, + "toObjectTypeId" : { + "type" : "string", + "description" : "Target object type." + } + }, + "description" : "The relationship descriptors applicable between two object types." + }, + "NextPage" : { + "required" : [ "after" ], + "type" : "object", + "properties" : { + "after" : { + "type" : "string", + "description" : "A paging cursor token for retrieving subsequent pages." + }, + "link" : { + "type" : "string", + "description" : "A URL that can be used to retrieve the next page results." + } + }, + "description" : "Specifies the paging information needed to retrieve the next set of results in a paginated API response" + }, + "Paging" : { + "type" : "object", + "properties" : { + "next" : { + "$ref" : "#/components/schemas/NextPage" + }, + "prev" : { + "$ref" : "#/components/schemas/PreviousPage" + } + }, + "description" : "Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results." + }, + "PreviousPage" : { + "required" : [ "before" ], + "type" : "object", + "properties" : { + "before" : { + "type" : "string", + "description" : "A paging cursor token for retrieving previous pages." + }, + "link" : { + "type" : "string", + "description" : "A URL that can be used to retrieve the previous pages' results." + } + }, + "description" : "specifies the paging information needed to retrieve the previous set of results in a paginated API response" + }, + "PublicAssociationsForObject" : { + "required" : [ "to", "types" ], + "type" : "object", + "properties" : { + "to" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "types" : { + "type" : "array", + "description" : "The types of associations that exist between the object and other entities, indicating the nature of their relationship.", + "items" : { + "$ref" : "#/components/schemas/AssociationSpec" + } + } + }, + "description" : "Represents the associations for a specific object in HubSpot, detailing the types of associations and the related objects involved." + }, + "PublicDefaultAssociation" : { + "required" : [ "associationSpec", "from", "to" ], + "type" : "object", + "properties" : { + "associationSpec" : { + "$ref" : "#/components/schemas/AssociationSpec" + }, + "from" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "to" : { + "$ref" : "#/components/schemas/PublicObjectId" + } + }, + "description" : "The PublicDefaultAssociation component represents the default association configuration between two objects in HubSpot. It is used to define how objects are related to each other within the platform." + }, + "PublicObjectId" : { + "required" : [ "id" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + } + }, + "description" : "Contains the Id of a Public Object" + }, + "PublicObjectSearchRequest" : { + "required" : [ "after", "filterGroups", "limit", "properties", "sorts" ], + "type" : "object", + "properties" : { + "after" : { + "type" : "string", + "description" : "A paging cursor token for retrieving subsequent pages." + }, + "filterGroups" : { + "type" : "array", + "description" : "Up to 6 groups of filters defining additional query criteria.", + "items" : { + "$ref" : "#/components/schemas/FilterGroup" + } + }, + "limit" : { + "type" : "integer", + "description" : "The maximum results to return, up to 200 objects.", + "format" : "int32" + }, + "properties" : { + "type" : "array", + "description" : "A list of property names to include in the response.", + "items" : { + "type" : "string" + } + }, + "query" : { + "type" : "string", + "description" : "The search query string, up to 3000 characters." + }, + "sorts" : { + "type" : "array", + "description" : "Specifies sorting order based on object properties.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Describes a search request" + }, + "PublicObjectWarning" : { + "required" : [ "category", "context", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The classification of the warning, indicating the type or nature of the issue." + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Additional information or metadata about the warning, providing context for understanding the issue." + }, + "message" : { + "type" : "string", + "description" : "The text of the warning message, providing information about the issue or alert." + } + }, + "description" : "Represents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning." + }, + "SimplePublicObject" : { + "required" : [ "archived", "createdAt", "id", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used to trace the write request for the object. Set a unique ID for each write operation; it is returned with any errors so you can identify which request encountered which error." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history, each with a timestamp and source information." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL associated with the object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "A simple public object." + }, + "SimplePublicObjectBatchInput" : { + "required" : [ "id", "properties" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id to be updated. This can be the object id, or the unique property value of the idProperty property" + }, + "idProperty" : { + "type" : "string", + "description" : "The name of a property whose values are unique for this object", + "example" : "my_unique_property_name" + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "A unique identifier for tracing the request." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs representing the properties of the object." + } + }, + "description" : "Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties." + }, + "SimplePublicObjectBatchInputForCreate" : { + "required" : [ "associations", "properties" ], + "type" : "object", + "properties" : { + "associations" : { + "type" : "array", + "description" : "An array of associations that define the relationships between the objects being created and other existing objects. This property is required.", + "items" : { + "$ref" : "#/components/schemas/PublicAssociationsForObject" + } + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the creation or update request of the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "An input object that contains a collection of objects to be created together in a batch." + }, + "SimplePublicObjectBatchInputUpsert" : { + "required" : [ "id", "properties" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "idProperty" : { + "type" : "string", + "description" : "The name of a property whose values are unique for this object" + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier for tracing the creation request." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID." + }, + "SimplePublicObjectId" : { + "required" : [ "id" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object.", + "example" : "430001" + } + }, + "description" : "Contains the Id of a Public Object" + }, + "SimplePublicObjectInput" : { + "required" : [ "properties" ], + "type" : "object", + "properties" : { + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "Represents the input required to update a CRM object, containing an object with property names and their corresponding values." + }, + "SimplePublicObjectInputForCreate" : { + "required" : [ "associations", "properties" ], + "type" : "object", + "properties" : { + "associations" : { + "type" : "array", + "description" : "An array that specifies the relationships between the new public object and existing objects. This is required to establish how the new object is connected within the system.", + "items" : { + "$ref" : "#/components/schemas/PublicAssociationsForObject" + } + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs for setting properties for the new object." + } + }, + "description" : "Is the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects." + }, + "SimplePublicObjectWithAssociations" : { + "required" : [ "archived", "createdAt", "id", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "associations" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/CollectionResponseAssociatedId" + }, + "description" : "A map of associated object types to their associated IDs." + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the creation or update request of the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL link to access this object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type." + }, + "SimplePublicUpsertObject" : { + "required" : [ "archived", "createdAt", "id", "new", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "new" : { + "type" : "boolean", + "description" : "Whether the property is new." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the write request for the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL associated with the object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "Represents a CRM object that has either been created or updated (upserted)" + }, + "StandardError" : { + "required" : [ "category", "context", "errors", "links", "message", "status" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The main category of the error." + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Additional context-specific information related to the error." + }, + "errors" : { + "type" : "array", + "description" : "The detailed error objects.", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "id" : { + "type" : "string", + "description" : "A unique ID for the error instance." + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "URLs linking to documentation or resources associated with the error." + }, + "message" : { + "type" : "string", + "description" : "A human-readable string describing the error and possible remediation steps." + }, + "status" : { + "type" : "string", + "description" : "A text status code for the error, typically \"error\"." + }, + "subCategory" : { + "type" : "object", + "properties" : { }, + "description" : "A more specific error category within each main category." + } + }, + "description" : "Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request." + }, + "ValueWithTimestamp" : { + "required" : [ "sourceType", "timestamp", "value" ], + "type" : "object", + "properties" : { + "sourceId" : { + "type" : "string", + "description" : "A string identifier for the specific source of the value." + }, + "sourceLabel" : { + "type" : "string", + "description" : "A human-readable label." + }, + "sourceType" : { + "type" : "string", + "description" : "A string indicating the type of source from which the value originated." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp when the property was updated, in ISO 8601 format.", + "format" : "date-time" + }, + "updatedByUserId" : { + "type" : "integer", + "description" : "The ID of the user who last updated the property.", + "format" : "int32" + }, + "value" : { + "type" : "string", + "description" : "The property value." + } + }, + "description" : "Property model that includes timestamp." + } + }, + "responses" : { + "Error" : { + "description" : "An error occurred.", + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + } + } + } + }, + "securitySchemes" : { + "developer_hapikey" : { + "type" : "apiKey", + "name" : "hapikey", + "in" : "query" + }, + "oauth2" : { + "type" : "oauth2", + "flows" : { + "authorizationCode" : { + "authorizationUrl" : "https://app.hubspot.com/oauth/authorize", + "tokenUrl" : "https://api.hubapi.com/oauth/v1/token", + "scopes" : { + "cpq.price_books.read" : "", + "crm.objects.appointments.read" : "", + "crm.objects.appointments.sensitive.read.v2" : "", + "crm.objects.appointments.sensitive.write.v2" : "", + "crm.objects.appointments.write" : "", + "crm.objects.calls.read" : "", + "crm.objects.calls.write" : "", + "crm.objects.carts.read" : "", + "crm.objects.carts.write" : "", + "crm.objects.commercepayments.read" : "", + "crm.objects.commercepayments.write" : "", + "crm.objects.companies.highly_sensitive.read.v2" : "", + "crm.objects.companies.highly_sensitive.write.v2" : "", + "crm.objects.companies.read" : "", + "crm.objects.companies.sensitive.read.v2" : "", + "crm.objects.companies.sensitive.write.v2" : "", + "crm.objects.companies.write" : "", + "crm.objects.contacts.highly_sensitive.read.v2" : "", + "crm.objects.contacts.highly_sensitive.write.v2" : "", + "crm.objects.contacts.read" : "", + "crm.objects.contacts.sensitive.read.v2" : "", + "crm.objects.contacts.sensitive.write.v2" : "", + "crm.objects.contacts.write" : "", + "crm.objects.contracts.read" : "", + "crm.objects.courses.read" : "", + "crm.objects.courses.write" : "", + "crm.objects.custom.highly_sensitive.read.v2" : "", + "crm.objects.custom.highly_sensitive.write.v2" : "", + "crm.objects.custom.read" : "", + "crm.objects.custom.sensitive.read.v2" : "", + "crm.objects.custom.sensitive.write.v2" : "", + "crm.objects.custom.write" : "", + "crm.objects.deals.highly_sensitive.read.v2" : "", + "crm.objects.deals.highly_sensitive.write.v2" : "", + "crm.objects.deals.read" : "", + "crm.objects.deals.sensitive.read.v2" : "", + "crm.objects.deals.sensitive.write.v2" : "", + "crm.objects.deals.write" : "", + "crm.objects.emails.read" : "", + "crm.objects.emails.write" : "", + "crm.objects.feedback_submissions.read" : "", + "crm.objects.forecasts.read" : "", + "crm.objects.goals.read" : "", + "crm.objects.goals.write" : "", + "crm.objects.invoices.read" : "", + "crm.objects.invoices.write" : "", + "crm.objects.leads.read" : "", + "crm.objects.leads.write" : "", + "crm.objects.line_items.read" : "", + "crm.objects.line_items.write" : "", + "crm.objects.listings.read" : "", + "crm.objects.listings.write" : "", + "crm.objects.meetings.read" : "", + "crm.objects.meetings.write" : "", + "crm.objects.notes.read" : "", + "crm.objects.notes.write" : "", + "crm.objects.orders.read" : "", + "crm.objects.orders.write" : "", + "crm.objects.partner-clients.read" : "", + "crm.objects.partner-clients.write" : "", + "crm.objects.partner-services.read" : "", + "crm.objects.partner-services.write" : "", + "crm.objects.products.read" : "", + "crm.objects.products.write" : "", + "crm.objects.projects.highly_sensitive.read" : "", + "crm.objects.projects.highly_sensitive.write" : "", + "crm.objects.projects.read" : "", + "crm.objects.projects.sensitive.read" : "", + "crm.objects.projects.sensitive.write" : "", + "crm.objects.projects.write" : "", + "crm.objects.quotes.read" : "", + "crm.objects.quotes.write" : "", + "crm.objects.services.read" : "", + "crm.objects.services.write" : "", + "crm.objects.subscriptions.read" : "", + "crm.objects.subscriptions.write" : "", + "crm.objects.tasks.read" : "", + "crm.objects.tasks.write" : "", + "crm.objects.tickets.highly_sensitive.read" : "", + "crm.objects.tickets.highly_sensitive.write" : "", + "crm.objects.tickets.read" : "", + "crm.objects.tickets.sensitive.read" : "", + "crm.objects.tickets.sensitive.write" : "", + "crm.objects.tickets.write" : "", + "crm.objects.users.read" : "", + "crm.objects.users.write" : "", + "e-commerce" : "", + "media_bridge.read" : "", + "oauth" : "", + "revenue.contracts.read" : "", + "tickets.highly_sensitive.v2" : "", + "tickets.sensitive.v2" : "" + } + } + }, + "x-hubspot-app-availability" : { + "cpq.price_books.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.appointments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.commercepayments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.commercepayments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.companies.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.contacts.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contracts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.custom.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.feedback_submissions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.forecasts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-clients.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-clients.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.products.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.products.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "e-commerce" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "media_bridge.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "oauth" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "revenue.contracts.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "tickets.highly_sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "tickets.sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + } + } + } + } + }, + "x-hubspot-available-client-libraries" : [ "Node", "Python", "Ruby", "PHP" ], + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + } +} \ No newline at end of file diff --git a/spec/hubspot/companies.json b/spec/hubspot/companies.json new file mode 100644 index 0000000..b37d577 --- /dev/null +++ b/spec/hubspot/companies.json @@ -0,0 +1,3162 @@ +{ + "openapi" : "3.0.1", + "info" : { + "title" : "Companies", + "description" : "Basepom for all HubSpot Projects", + "version" : "2026-03", + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + }, + "x-hubspot-api-use-case" : "When a new customer signs up on your website with their business email address, create a company record to represent the relationship between the customer and the company they work for. A sales rep can later use this company record for outreach to find other potential sales opportunities. ", + "x-hubspot-introduction" : "Use the companies API to create and manage CRM records that represent the companies and organizations that interact with your business." + }, + "servers" : [ { + "url" : "https://api.hubapi.com" + } ], + "tags" : [ { + "name" : "Advanced" + }, { + "name" : "Basic" + }, { + "name" : "Batch" + }, { + "name" : "Search" + } ], + "paths" : { + "/crm/objects/2026-03/companies" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Retrieve companies", + "description" : "Retrieve all companies, using query parameters to control the information that gets returned.", + "operationId" : "get-/crm/objects/2026-03/companies_getPage", + "parameters" : [ { + "name" : "after", + "in" : "query", + "description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "associations", + "in" : "query", + "description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum number of results to display per page.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 10 + } + }, { + "name" : "properties", + "in" : "query", + "description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "propertiesWithHistory", + "in" : "query", + "description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponseSimplePublicObjectWithAssociationsForwardPaging" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "post" : { + "tags" : [ "Basic" ], + "summary" : "Create a company", + "description" : "Create a single company. Include a `properties` object to define [property values](https://developers.hubspot.com/docs/guides/api/crm/properties) for the company, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.", + "operationId" : "post-/crm/objects/2026-03/companies_create", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectInputForCreate" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "headers" : { + "Location" : { + "description" : "URL of the newly created resource", + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/companies/batch/archive" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Archive a batch of companies", + "description" : "Delete a batch of companies by ID. Deleted companies can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).", + "operationId" : "post-/crm/objects/2026-03/companies/batch/archive_archive", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectId" + } + } + }, + "required" : true + }, + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/companies/batch/create" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Create a batch of companies", + "description" : "Create a batch of companies. The `inputs` array can contain a `properties` object to define property values for each company, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.", + "operationId" : "post-/crm/objects/2026-03/companies/batch/create_create", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputForCreate" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/companies/batch/read" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Retrieve a batch of companies", + "description" : "Retrieve a batch of companies by ID (`companyId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter.", + "operationId" : "post-/crm/objects/2026-03/companies/batch/read_read", + "parameters" : [ { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchReadInputSimplePublicObjectId" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/companies/batch/update" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Update a batch of companies", + "description" : "Update a batch of companies by ID.", + "operationId" : "post-/crm/objects/2026-03/companies/batch/update_update", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/companies/batch/upsert" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Create or update a batch of companies by unique property values", + "description" : "Create or update companies identified by a unique property value as specified by the `idProperty` query parameter. `idProperty` query param refers to a property whose values are unique for the object.", + "operationId" : "post-/crm/objects/2026-03/companies/batch/upsert_upsert", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputUpsert" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicUpsertObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicUpsertObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/companies/merge" : { + "post" : { + "tags" : [ "Advanced" ], + "summary" : "Merge two companies", + "description" : "Merge two company records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records).", + "operationId" : "post-/crm/objects/2026-03/companies/merge_merge", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PublicMergeInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/companies/search" : { + "post" : { + "tags" : [ "Search" ], + "summary" : "Search for companies", + "description" : "Search for companies by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).", + "operationId" : "post-/crm/objects/2026-03/companies/search_doSearch", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PublicObjectSearchRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponseWithTotalSimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/companies/{companyId}" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Retrieve a company", + "description" : "Retrieve a company by its ID (`companyId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter.", + "operationId" : "get-/crm/objects/2026-03/companies/{companyId}_getById", + "parameters" : [ { + "name" : "companyId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + }, { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "associations", + "in" : "query", + "description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "idProperty", + "in" : "query", + "description" : "The name of a property whose values are unique for this object type", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "properties", + "in" : "query", + "description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "propertiesWithHistory", + "in" : "query", + "description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "delete" : { + "tags" : [ "Basic" ], + "summary" : "Archive a company", + "description" : "Delete a company by ID. Deleted companies can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).", + "operationId" : "delete-/crm/objects/2026-03/companies/{companyId}_archive", + "parameters" : [ { + "name" : "companyId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "patch" : { + "tags" : [ "Basic" ], + "summary" : "Update a company", + "description" : "Update a company by ID (`companyId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + "operationId" : "patch-/crm/objects/2026-03/companies/{companyId}_update", + "parameters" : [ { + "name" : "companyId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + }, { + "name" : "idProperty", + "in" : "query", + "description" : "The name of a property whose values are unique for this object type", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}" : { + "put" : { + "tags" : [ "Batch" ], + "operationId" : "put-/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "fromObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "fromObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponsePublicDefaultAssociation" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}" : { + "put" : { + "tags" : [ "Basic" ], + "operationId" : "put-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "objectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AssociationSpec" + } + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "headers" : { + "Location" : { + "description" : "URL of the newly created resource", + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LabelsBetweenObjectPair" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "delete" : { + "tags" : [ "Basic" ], + "operationId" : "delete-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "objectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : true + } + } + } + }, + "components" : { + "schemas" : { + "AssociatedId" : { + "required" : [ "id", "type" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique identifier for the associated object." + }, + "type" : { + "type" : "string", + "description" : "The type of associations.", + "example" : "deal_to_contact" + } + }, + "description" : "Contains the id and type of an association" + }, + "AssociationSpec" : { + "required" : [ "associationCategory", "associationTypeId" ], + "type" : "object", + "properties" : { + "associationCategory" : { + "type" : "string", + "description" : "For [labeled associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4#associate-records-with-a-label), the category of the association.", + "enum" : [ "HUBSPOT_DEFINED", "INTEGRATOR_DEFINED", "USER_DEFINED", "WORK" ] + }, + "associationTypeId" : { + "type" : "integer", + "description" : "The [association type ID](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4#association-type-id-values) (e.g., `4` for contact-to-company associations).", + "format" : "int32" + } + }, + "description" : "Defines the type, direction, and details of the relationship between two CRM objects." + }, + "BatchInputSimplePublicObjectBatchInput" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be processed in the batch operation. Each object in the array contains the data necessary for the specific operation being performed.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInput" + } + } + }, + "description" : "Represents a batch input component used to handle multiple simple public objects in a single API request. This component is typically used when performing batch operations to create, update, or delete multiple records simultaneously." + }, + "BatchInputSimplePublicObjectBatchInputForCreate" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be created. Each object in the array contains the necessary data for creating a new entry in the system.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInputForCreate" + } + } + }, + "description" : "Represents a batch input for creating multiple simple public objects in a single request. This component is used to streamline the process of adding new objects to a HubSpot account by allowing multiple entries to be created at once." + }, + "BatchInputSimplePublicObjectBatchInputUpsert" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be upserted. Each object in the array contains the necessary data for creating or updating a record in HubSpot.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInputUpsert" + } + } + }, + "description" : "Represents a batch input operation for upserting simple public objects in HubSpot. This component is used to process multiple upsert operations in a single request, improving efficiency and performance." + }, + "BatchInputSimplePublicObjectId" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public object IDs to be processed in the batch operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectId" + } + } + }, + "description" : "Represents a batch input payload containing a list of simple public object IDs. This component is used when performing batch operations on multiple objects within HubSpot." + }, + "BatchReadInputSimplePublicObjectId" : { + "required" : [ "inputs", "properties", "propertiesWithHistory" ], + "type" : "object", + "properties" : { + "idProperty" : { + "type" : "string", + "description" : "When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID." + }, + "inputs" : { + "type" : "array", + "description" : "An array of SimplePublicObjectId objects, each containing the ID of an object to be read.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectId" + } + }, + "properties" : { + "type" : "array", + "description" : "An array of the property names to be returned in the response. If a specified property is not present on the requested object(s), it will be ignored.", + "items" : { + "type" : "string" + } + }, + "propertiesWithHistory" : { + "type" : "array", + "description" : "An array of the property names to be returned along with their history of previous values. If a specified property is not present on the requested object(s), it will be ignored.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property." + }, + "BatchResponsePublicDefaultAssociation" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "description" : "An array of StandardError objects detailing any errors that occurred during the batch operation.", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "numErrors" : { + "type" : "integer", + "description" : "The total number of errors that occurred during the operation.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of PublicDefaultAssociation objects representing the results of the batch operation.", + "items" : { + "$ref" : "#/components/schemas/PublicDefaultAssociation" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "The response returned after performing a batch operation on associations." + }, + "BatchResponseSimplePublicObject" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch request was initially made, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of SimplePublicObject items representing the results of the batch operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing began, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. The expected value is \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "A public object batch response object" + }, + "BatchResponseSimplePublicObjectWithErrors" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "numErrors" : { + "type" : "integer", + "description" : "The number of errors encountered during the batch process.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request - \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\"", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the result of a batch operation on CRM objects, including the processing status, batch results, timestamps, and a list of any errors encountered during the operation." + }, + "BatchResponseSimplePublicUpsertObject" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of SimplePublicUpsertObject items representing the results of the batch upsert operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicUpsertObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. The expected value is \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects." + }, + "BatchResponseSimplePublicUpsertObjectWithErrors" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "numErrors" : { + "type" : "integer", + "description" : "The number of errors encountered during the batch process.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SimplePublicUpsertObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the response from a batch upsert operation, including the status, timestamps, successfully processed objects, and any errors that occurred during processing." + }, + "CollectionResponseAssociatedId" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/Paging" + }, + "results" : { + "type" : "array", + "description" : "A list of associated IDs retrieved from the API request.", + "items" : { + "$ref" : "#/components/schemas/AssociatedId" + } + } + }, + "description" : "Represents a collection of associated IDs returned by an API request, including pagination details for navigating through the results." + }, + "CollectionResponseSimplePublicObjectWithAssociationsForwardPaging" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/ForwardPaging" + }, + "results" : { + "type" : "array", + "description" : "An array of simple public objects that are included in the current page of the response. Each object may include its associated data.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations" + } + } + }, + "description" : "Represents a paginated collection response that includes simple public objects with their associations. This component is used to handle the results and pagination details when retrieving a list of objects from the API." + }, + "CollectionResponseWithTotalSimplePublicObject" : { + "required" : [ "results", "total" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/Paging" + }, + "results" : { + "type" : "array", + "description" : "An array containing the simple public objects returned in the current page of the response. This property is required.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "total" : { + "type" : "integer", + "description" : "The number of available results", + "format" : "int32" + } + }, + "description" : "Represents a list of simple objects returned from an API request, along with the total count of objects available." + }, + "Error" : { + "required" : [ "category", "correlationId", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The error category" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}" + }, + "correlationId" : { + "type" : "string", + "description" : "A unique identifier for the request. Include this value with any error reports or support tickets", + "format" : "uuid", + "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf" + }, + "errors" : { + "type" : "array", + "description" : "further information about the error", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps" + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate", + "example" : "An error occurred" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered.", + "example" : { + "message" : "Invalid input (details will vary based on the error)", + "correlationId" : "aeb5f871-7f07-4993-9211-075dc63e7cbf", + "category" : "VALIDATION_ERROR", + "links" : { + "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base" + } + } + }, + "ErrorDetail" : { + "required" : [ "message" ], + "type" : "object", + "properties" : { + "code" : { + "type" : "string", + "description" : "The status code associated with the error detail" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{missingScopes=[scope1, scope2]}" + }, + "in" : { + "type" : "string", + "description" : "The name of the field or parameter in which the error was found." + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response." + }, + "Filter" : { + "required" : [ "operator", "propertyName" ], + "type" : "object", + "properties" : { + "highValue" : { + "type" : "string", + "description" : "The upper boundary value when using ranged-based filters." + }, + "operator" : { + "type" : "string", + "description" : "The comparison operator used in the filter, such as \"EQ\" or \"GT\".", + "enum" : [ "BETWEEN", "CONTAINS_TOKEN", "EQ", "GT", "GTE", "HAS_PROPERTY", "IN", "LT", "LTE", "NEQ", "NOT_CONTAINS_TOKEN", "NOT_HAS_PROPERTY", "NOT_IN" ] + }, + "propertyName" : { + "type" : "string", + "description" : "The name of the property to apply the filter to." + }, + "value" : { + "type" : "string", + "description" : "The value to match against the property." + }, + "values" : { + "type" : "array", + "description" : "The values to match against the property.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against. " + }, + "FilterGroup" : { + "required" : [ "filters" ], + "type" : "object", + "properties" : { + "filters" : { + "type" : "array", + "description" : "A list of individual filter criteria that are applied together as a group. Each filter specifies a condition that records must meet to be included in the results.", + "items" : { + "$ref" : "#/components/schemas/Filter" + } + } + }, + "description" : "Represents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints." + }, + "ForwardPaging" : { + "type" : "object", + "properties" : { + "next" : { + "$ref" : "#/components/schemas/NextPage" + } + }, + "description" : "Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page." + }, + "LabelsBetweenObjectPair" : { + "required" : [ "fromObjectId", "fromObjectTypeId", "labels", "toObjectId", "toObjectTypeId" ], + "type" : "object", + "properties" : { + "fromObjectId" : { + "type" : "string", + "description" : "Source unique ID of the object." + }, + "fromObjectTypeId" : { + "type" : "string", + "description" : "Source object type." + }, + "labels" : { + "type" : "array", + "description" : "An array of labels that describe the relationship between the two objects. This is a required property.", + "items" : { + "type" : "string" + } + }, + "toObjectId" : { + "type" : "string", + "description" : "Target unique ID of the object." + }, + "toObjectTypeId" : { + "type" : "string", + "description" : "Target object type." + } + }, + "description" : "The relationship descriptors applicable between two object types." + }, + "NextPage" : { + "required" : [ "after" ], + "type" : "object", + "properties" : { + "after" : { + "type" : "string", + "description" : "A paging cursor token for retrieving subsequent pages." + }, + "link" : { + "type" : "string", + "description" : "A URL that can be used to retrieve the next page results." + } + }, + "description" : "Specifies the paging information needed to retrieve the next set of results in a paginated API response" + }, + "Paging" : { + "type" : "object", + "properties" : { + "next" : { + "$ref" : "#/components/schemas/NextPage" + }, + "prev" : { + "$ref" : "#/components/schemas/PreviousPage" + } + }, + "description" : "Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results." + }, + "PreviousPage" : { + "required" : [ "before" ], + "type" : "object", + "properties" : { + "before" : { + "type" : "string", + "description" : "A paging cursor token for retrieving previous pages." + }, + "link" : { + "type" : "string", + "description" : "A URL that can be used to retrieve the previous pages' results." + } + }, + "description" : "specifies the paging information needed to retrieve the previous set of results in a paginated API response" + }, + "PublicAssociationsForObject" : { + "required" : [ "to", "types" ], + "type" : "object", + "properties" : { + "to" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "types" : { + "type" : "array", + "description" : "The types of associations that exist between the object and other entities, indicating the nature of their relationship.", + "items" : { + "$ref" : "#/components/schemas/AssociationSpec" + } + } + }, + "description" : "Represents the associations for a specific object in HubSpot, detailing the types of associations and the related objects involved." + }, + "PublicDefaultAssociation" : { + "required" : [ "associationSpec", "from", "to" ], + "type" : "object", + "properties" : { + "associationSpec" : { + "$ref" : "#/components/schemas/AssociationSpec" + }, + "from" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "to" : { + "$ref" : "#/components/schemas/PublicObjectId" + } + }, + "description" : "The PublicDefaultAssociation component represents the default association configuration between two objects in HubSpot. It is used to define how objects are related to each other within the platform." + }, + "PublicMergeInput" : { + "required" : [ "objectIdToMerge", "primaryObjectId" ], + "type" : "object", + "properties" : { + "objectIdToMerge" : { + "type" : "string", + "description" : "The ID of the company to merge into the primary." + }, + "primaryObjectId" : { + "type" : "string", + "description" : "The ID of the primary company, which the other will merge into." + } + }, + "description" : "Input data for merging two records." + }, + "PublicObjectId" : { + "required" : [ "id" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the target record to associate." + } + }, + "description" : "Contains the Id of a Public Object" + }, + "PublicObjectSearchRequest" : { + "required" : [ "after", "filterGroups", "limit", "properties", "sorts" ], + "type" : "object", + "properties" : { + "after" : { + "type" : "string", + "description" : "A paging cursor token for retrieving subsequent pages." + }, + "filterGroups" : { + "type" : "array", + "description" : "Up to 6 groups of filters defining additional query criteria.", + "items" : { + "$ref" : "#/components/schemas/FilterGroup" + } + }, + "limit" : { + "type" : "integer", + "description" : "The maximum results to return, up to 200 objects.", + "format" : "int32" + }, + "properties" : { + "type" : "array", + "description" : "A list of property names to include in the response.", + "items" : { + "type" : "string" + } + }, + "query" : { + "type" : "string", + "description" : "The search query string, up to 3000 characters." + }, + "sorts" : { + "type" : "array", + "description" : "Specifies sorting order based on object properties.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Describes a search request" + }, + "PublicObjectWarning" : { + "required" : [ "category", "context", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The classification of the warning, indicating the type or nature of the issue." + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Additional information or metadata about the warning, providing context for understanding the issue." + }, + "message" : { + "type" : "string", + "description" : "The text of the warning message, providing information about the issue or alert." + } + }, + "description" : "Represents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning." + }, + "SimplePublicObject" : { + "required" : [ "archived", "createdAt", "id", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used to trace the write request for the object. Set a unique ID for each write operation; it is returned with any errors so you can identify which request encountered which error." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history, each with a timestamp and source information." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL associated with the object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "A simple public object." + }, + "SimplePublicObjectBatchInput" : { + "required" : [ "id", "properties" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID to be updated. This can be the object ID, or the unique property value of the `idProperty` property." + }, + "idProperty" : { + "type" : "string", + "description" : "The name of a property whose values are unique for this object", + "example" : "my_unique_property_name" + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "In each input object, set this field to a unique ID value to enable more granular debugging for error responses. Learn more about [multi-status errors](https://developers.hubspot.com/docs/reference/api/other-resources/error-handling#multi-status-errors)." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "The company property values to set." + } + }, + "description" : "Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties." + }, + "SimplePublicObjectBatchInputForCreate" : { + "required" : [ "associations", "properties" ], + "type" : "object", + "properties" : { + "associations" : { + "type" : "array", + "description" : "An array of associations that define the relationships between the objects being created and other existing objects. This property is required.", + "items" : { + "$ref" : "#/components/schemas/PublicAssociationsForObject" + } + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the creation or update request of the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "An input object that contains a collection of objects to be created together in a batch." + }, + "SimplePublicObjectBatchInputUpsert" : { + "required" : [ "id", "properties" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the company to update." + }, + "idProperty" : { + "type" : "string", + "description" : "The name of a property whose values are unique for this object" + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "In each input object, set this field to a unique ID value to enable more granular debugging for error responses. Learn more about [multi-status errors](https://developers.hubspot.com/docs/reference/api/other-resources/error-handling#multi-status-errors)." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "The company property values to set." + } + }, + "description" : "Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID." + }, + "SimplePublicObjectId" : { + "required" : [ "id" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object.", + "example" : "430001" + } + }, + "description" : "Contains the Id of a Public Object" + }, + "SimplePublicObjectInput" : { + "required" : [ "properties" ], + "type" : "object", + "properties" : { + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "The company property values to set." + } + }, + "description" : "Represents the input required to update a CRM object, containing an object with property names and their corresponding values." + }, + "SimplePublicObjectInputForCreate" : { + "required" : [ "associations", "properties" ], + "type" : "object", + "properties" : { + "associations" : { + "type" : "array", + "description" : "An array that specifies the relationships between the new public object and existing objects. This is required to establish how the new object is connected within the system.", + "items" : { + "$ref" : "#/components/schemas/PublicAssociationsForObject" + } + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "The company property values to set." + } + }, + "description" : "Is the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects." + }, + "SimplePublicObjectWithAssociations" : { + "required" : [ "archived", "createdAt", "id", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "associations" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/CollectionResponseAssociatedId" + }, + "description" : "A map of associated object types to their associated IDs." + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the creation or update request of the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL link to access this object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type." + }, + "SimplePublicUpsertObject" : { + "required" : [ "archived", "createdAt", "id", "new", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "new" : { + "type" : "boolean", + "description" : "Whether the property is new." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the write request for the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL associated with the object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "Represents a CRM object that has either been created or updated (upserted)" + }, + "StandardError" : { + "required" : [ "category", "context", "errors", "links", "message", "status" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The main category of the error." + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Additional context-specific information related to the error." + }, + "errors" : { + "type" : "array", + "description" : "The detailed error objects.", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "id" : { + "type" : "string", + "description" : "A unique ID for the error instance." + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "URLs linking to documentation or resources associated with the error." + }, + "message" : { + "type" : "string", + "description" : "A human-readable string describing the error and possible remediation steps." + }, + "status" : { + "type" : "string", + "description" : "A text status code for the error, typically \"error\"." + }, + "subCategory" : { + "type" : "object", + "properties" : { }, + "description" : "A more specific error category within each main category." + } + }, + "description" : "Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request." + }, + "ValueWithTimestamp" : { + "required" : [ "sourceType", "timestamp", "value" ], + "type" : "object", + "properties" : { + "sourceId" : { + "type" : "string", + "description" : "A string identifier for the specific source of the value." + }, + "sourceLabel" : { + "type" : "string", + "description" : "A human-readable label." + }, + "sourceType" : { + "type" : "string", + "description" : "A string indicating the type of source from which the value originated." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp when the property was updated, in ISO 8601 format.", + "format" : "date-time" + }, + "updatedByUserId" : { + "type" : "integer", + "description" : "The ID of the user who last updated the property.", + "format" : "int32" + }, + "value" : { + "type" : "string", + "description" : "The property value." + } + }, + "description" : "Property model that includes timestamp." + } + }, + "responses" : { + "Error" : { + "description" : "An error occurred.", + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + } + } + } + }, + "securitySchemes" : { + "developer_hapikey" : { + "type" : "apiKey", + "name" : "hapikey", + "in" : "query" + }, + "oauth2" : { + "type" : "oauth2", + "flows" : { + "authorizationCode" : { + "authorizationUrl" : "https://app.hubspot.com/oauth/authorize", + "tokenUrl" : "https://api.hubapi.com/oauth/v1/token", + "scopes" : { + "cpq.price_books.read" : "", + "crm.objects.appointments.read" : "", + "crm.objects.appointments.sensitive.read.v2" : "", + "crm.objects.appointments.sensitive.write.v2" : "", + "crm.objects.appointments.write" : "", + "crm.objects.calls.read" : "", + "crm.objects.calls.write" : "", + "crm.objects.carts.read" : "", + "crm.objects.carts.write" : "", + "crm.objects.commercepayments.read" : "", + "crm.objects.commercepayments.write" : "", + "crm.objects.companies.highly_sensitive.read.v2" : "", + "crm.objects.companies.highly_sensitive.write.v2" : "", + "crm.objects.companies.read" : "", + "crm.objects.companies.sensitive.read.v2" : "", + "crm.objects.companies.sensitive.write.v2" : "", + "crm.objects.companies.write" : "", + "crm.objects.contacts.highly_sensitive.read.v2" : "", + "crm.objects.contacts.highly_sensitive.write.v2" : "", + "crm.objects.contacts.read" : "", + "crm.objects.contacts.sensitive.read.v2" : "", + "crm.objects.contacts.sensitive.write.v2" : "", + "crm.objects.contacts.write" : "", + "crm.objects.contracts.read" : "", + "crm.objects.courses.read" : "", + "crm.objects.courses.write" : "", + "crm.objects.custom.highly_sensitive.read.v2" : "", + "crm.objects.custom.highly_sensitive.write.v2" : "", + "crm.objects.custom.read" : "", + "crm.objects.custom.sensitive.read.v2" : "", + "crm.objects.custom.sensitive.write.v2" : "", + "crm.objects.custom.write" : "", + "crm.objects.deals.highly_sensitive.read.v2" : "", + "crm.objects.deals.highly_sensitive.write.v2" : "", + "crm.objects.deals.read" : "", + "crm.objects.deals.sensitive.read.v2" : "", + "crm.objects.deals.sensitive.write.v2" : "", + "crm.objects.deals.write" : "", + "crm.objects.emails.read" : "", + "crm.objects.emails.write" : "", + "crm.objects.feedback_submissions.read" : "", + "crm.objects.forecasts.read" : "", + "crm.objects.goals.read" : "", + "crm.objects.goals.write" : "", + "crm.objects.invoices.read" : "", + "crm.objects.invoices.write" : "", + "crm.objects.leads.read" : "", + "crm.objects.leads.write" : "", + "crm.objects.line_items.read" : "", + "crm.objects.line_items.write" : "", + "crm.objects.listings.read" : "", + "crm.objects.listings.write" : "", + "crm.objects.meetings.read" : "", + "crm.objects.meetings.write" : "", + "crm.objects.notes.read" : "", + "crm.objects.notes.write" : "", + "crm.objects.orders.read" : "", + "crm.objects.orders.write" : "", + "crm.objects.partner-clients.read" : "", + "crm.objects.partner-clients.write" : "", + "crm.objects.partner-services.read" : "", + "crm.objects.partner-services.write" : "", + "crm.objects.products.read" : "", + "crm.objects.products.write" : "", + "crm.objects.projects.highly_sensitive.read" : "", + "crm.objects.projects.highly_sensitive.write" : "", + "crm.objects.projects.read" : "", + "crm.objects.projects.sensitive.read" : "", + "crm.objects.projects.sensitive.write" : "", + "crm.objects.projects.write" : "", + "crm.objects.quotes.read" : "", + "crm.objects.quotes.write" : "", + "crm.objects.services.read" : "", + "crm.objects.services.write" : "", + "crm.objects.subscriptions.read" : "", + "crm.objects.subscriptions.write" : "", + "crm.objects.tasks.read" : "", + "crm.objects.tasks.write" : "", + "crm.objects.tickets.highly_sensitive.read" : "", + "crm.objects.tickets.highly_sensitive.write" : "", + "crm.objects.tickets.read" : "", + "crm.objects.tickets.sensitive.read" : "", + "crm.objects.tickets.sensitive.write" : "", + "crm.objects.tickets.write" : "", + "crm.objects.users.read" : "", + "crm.objects.users.write" : "", + "e-commerce" : "", + "media_bridge.read" : "", + "oauth" : "", + "revenue.contracts.read" : "", + "tickets.highly_sensitive.v2" : "", + "tickets.sensitive.v2" : "" + } + } + }, + "x-hubspot-app-availability" : { + "cpq.price_books.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.appointments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.commercepayments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.commercepayments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.companies.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.contacts.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contracts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.custom.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.feedback_submissions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.forecasts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-clients.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-clients.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.products.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.products.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "e-commerce" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "media_bridge.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "oauth" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "revenue.contracts.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "tickets.highly_sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "tickets.sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + } + } + } + } + }, + "x-hubspot-available-client-libraries" : [ "Node", "Python", "Ruby", "PHP" ], + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + } +} \ No newline at end of file diff --git a/spec/hubspot/contacts.json b/spec/hubspot/contacts.json new file mode 100644 index 0000000..fd78419 --- /dev/null +++ b/spec/hubspot/contacts.json @@ -0,0 +1,3213 @@ +{ + "openapi" : "3.0.1", + "info" : { + "title" : "Contacts", + "description" : "Basepom for all HubSpot Projects", + "version" : "2026-03", + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + }, + "x-hubspot-api-use-case" : "Retrieve a contact by ID to bring that contact data into your external system.", + "x-hubspot-introduction" : "Use the contacts API to create and manage contacts." + }, + "servers" : [ { + "url" : "https://api.hubapi.com" + } ], + "tags" : [ { + "name" : "Advanced" + }, { + "name" : "Basic" + }, { + "name" : "Batch" + }, { + "name" : "Search" + } ], + "paths" : { + "/crm/objects/2026-03/contacts" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Retrieve contacts", + "description" : "Retrieve all contacts, using query parameters to specify the information that gets returned.", + "operationId" : "get-/crm/objects/2026-03/contacts_getPage", + "parameters" : [ { + "name" : "after", + "in" : "query", + "description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "associations", + "in" : "query", + "description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum number of results to display per page.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 10 + } + }, { + "name" : "properties", + "in" : "query", + "description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "propertiesWithHistory", + "in" : "query", + "description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponseSimplePublicObjectWithAssociationsForwardPaging" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "post" : { + "tags" : [ "Basic" ], + "summary" : "Create a contact", + "description" : "Create a single contact. Include a `properties` object to define [property values](https://developers.hubspot.com/docs/guides/api/crm/properties) for the contact, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.", + "operationId" : "post-/crm/objects/2026-03/contacts_create", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectInputForCreate" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "headers" : { + "Location" : { + "description" : "URL of the newly created resource", + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/contacts/batch/archive" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Archive a batch of contacts", + "description" : "Archive a batch of contacts by ID. Archived contacts can be restored within 90 days of deletion. Learn more about the [data impacted by contact deletions](https://knowledge.hubspot.com/privacy-and-consent/understand-restorable-and-permanent-contact-deletions) and how to [restore archived records](https://knowledge.hubspot.com/records/restore-deleted-records).", + "operationId" : "post-/crm/objects/2026-03/contacts/batch/archive_archive", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectId" + } + } + }, + "required" : true + }, + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/contacts/batch/create" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Create a batch of contacts", + "description" : "Create a batch of contacts. The `inputs` array can contain a `properties` object to define property values for each record, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.", + "operationId" : "post-/crm/objects/2026-03/contacts/batch/create_create", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputForCreate" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/contacts/batch/read" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Retrieve a batch of contacts", + "description" : "Retrieve a batch of contacts by ID (`contactId`) or unique property value (`idProperty`). ", + "operationId" : "post-/crm/objects/2026-03/contacts/batch/read_read", + "parameters" : [ { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchReadInputSimplePublicObjectId" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/contacts/batch/update" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Update a batch of contacts", + "description" : "Update a batch of contacts by ID (`contactId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + "operationId" : "post-/crm/objects/2026-03/contacts/batch/update_update", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/contacts/batch/upsert" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Create or update a batch of contacts", + "description" : "Upsert a batch of contacts. The `inputs` array can contain a `properties` object to define property values for each record.", + "operationId" : "post-/crm/objects/2026-03/contacts/batch/upsert_upsert", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputUpsert" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicUpsertObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicUpsertObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/contacts/gdpr-delete" : { + "post" : { + "tags" : [ "Advanced" ], + "summary" : "Permanently delete a contact (GDPR-compliant)", + "description" : "Permanently delete a contact and all associated content to follow GDPR. Use optional property `idProperty` set to `email` to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future. Learn more about [permanently deleting contacts](https://knowledge.hubspot.com/privacy-and-consent/how-do-i-perform-a-gdpr-delete-in-hubspot).", + "operationId" : "post-/crm/objects/2026-03/contacts/gdpr-delete_purge", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PublicGdprDeleteInput" + } + } + }, + "required" : true + }, + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ] + } + }, + "/crm/objects/2026-03/contacts/merge" : { + "post" : { + "tags" : [ "Advanced" ], + "summary" : "Merge two contacts", + "description" : "Merge two contact records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records). ", + "operationId" : "post-/crm/objects/2026-03/contacts/merge_merge", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PublicMergeInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/contacts/search" : { + "post" : { + "tags" : [ "Search" ], + "summary" : "Search for contacts", + "description" : "Search for contacts by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).", + "operationId" : "post-/crm/objects/2026-03/contacts/search_doSearch", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PublicObjectSearchRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponseWithTotalSimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/contacts/{contactId}" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Retrieve a contact", + "description" : "Retrieve a contact by its ID (`contactId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter.", + "operationId" : "get-/crm/objects/2026-03/contacts/{contactId}_getById", + "parameters" : [ { + "name" : "contactId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + }, { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "associations", + "in" : "query", + "description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "idProperty", + "in" : "query", + "description" : "The name of a property whose values are unique for this object type", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "properties", + "in" : "query", + "description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "propertiesWithHistory", + "in" : "query", + "description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "delete" : { + "tags" : [ "Basic" ], + "summary" : "Archive a contact", + "description" : "Delete a contact by ID. Deleted contacts can be restored within 90 days of deletion. Learn more about the [data impacted by contact deletions](https://knowledge.hubspot.com/privacy-and-consent/understand-restorable-and-permanent-contact-deletions) and how to [restore archived records](https://knowledge.hubspot.com/records/restore-deleted-records).", + "operationId" : "delete-/crm/objects/2026-03/contacts/{contactId}_archive", + "parameters" : [ { + "name" : "contactId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "patch" : { + "tags" : [ "Basic" ], + "summary" : "Update a contact", + "description" : "Update an existing contact, identified by ID or email/unique property value. To identify a contact by ID, include the ID in the request URL path. To identify a contact by their email or other unique property, include the email/property value in the request URL path, and add the `idProperty` query parameter (`/crm/v3/objects/contacts/jon@website.com?idProperty=email`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + "operationId" : "patch-/crm/objects/2026-03/contacts/{contactId}_update", + "parameters" : [ { + "name" : "contactId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + }, { + "name" : "idProperty", + "in" : "query", + "description" : "The name of a property whose values are unique for this object type", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}" : { + "put" : { + "tags" : [ "Batch" ], + "summary" : "", + "description" : "", + "operationId" : "put-/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "fromObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "fromObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponsePublicDefaultAssociation" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}" : { + "put" : { + "tags" : [ "Basic" ], + "summary" : "", + "description" : "", + "operationId" : "put-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "objectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AssociationSpec" + } + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "headers" : { + "Location" : { + "description" : "URL of the newly created resource", + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LabelsBetweenObjectPair" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "delete" : { + "tags" : [ "Basic" ], + "summary" : "", + "description" : "", + "operationId" : "delete-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "objectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : true + } + } + } + }, + "components" : { + "schemas" : { + "AssociatedId" : { + "required" : [ "id", "type" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique identifier for the associated object." + }, + "type" : { + "type" : "string", + "description" : "The type of associations.", + "example" : "deal_to_contact" + } + }, + "description" : "Contains the id and type of an association" + }, + "AssociationSpec" : { + "required" : [ "associationCategory", "associationTypeId" ], + "type" : "object", + "properties" : { + "associationCategory" : { + "type" : "string", + "description" : "The category of the association, indicating its origin or purpose. Valid values include \"HUBSPOT_DEFINED\", \"USER_DEFINED\", \"INTEGRATOR_DEFINED\", and \"WORK\".", + "enum" : [ "HUBSPOT_DEFINED", "INTEGRATOR_DEFINED", "USER_DEFINED", "WORK" ] + }, + "associationTypeId" : { + "type" : "integer", + "description" : "An integer representing the unique identifier for the type of association.", + "format" : "int32" + } + }, + "description" : "Defines the type, direction, and details of the relationship between two CRM objects." + }, + "BatchInputSimplePublicObjectBatchInput" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be processed in the batch operation. Each object in the array contains the data necessary for the specific operation being performed.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInput" + } + } + }, + "description" : "Represents a batch input component used to handle multiple simple public objects in a single API request. This component is typically used when performing batch operations to create, update, or delete multiple records simultaneously." + }, + "BatchInputSimplePublicObjectBatchInputForCreate" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be created. Each object in the array contains the necessary data for creating a new entry in the system.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInputForCreate" + } + } + }, + "description" : "Represents a batch input for creating multiple simple public objects in a single request. This component is used to streamline the process of adding new objects to a HubSpot account by allowing multiple entries to be created at once." + }, + "BatchInputSimplePublicObjectBatchInputUpsert" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be upserted. Each object in the array contains the necessary data for creating or updating a record in HubSpot.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInputUpsert" + } + } + }, + "description" : "Represents a batch input operation for upserting simple public objects in HubSpot. This component is used to process multiple upsert operations in a single request, improving efficiency and performance." + }, + "BatchInputSimplePublicObjectId" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public object IDs to be processed in the batch operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectId" + } + } + }, + "description" : "Represents a batch input payload containing a list of simple public object IDs. This component is used when performing batch operations on multiple objects within HubSpot." + }, + "BatchReadInputSimplePublicObjectId" : { + "required" : [ "inputs", "properties", "propertiesWithHistory" ], + "type" : "object", + "properties" : { + "idProperty" : { + "type" : "string", + "description" : "When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID." + }, + "inputs" : { + "type" : "array", + "description" : "An array of SimplePublicObjectId objects, each containing the ID of an object to be read.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectId" + } + }, + "properties" : { + "type" : "array", + "description" : "An array of the property names to be returned in the response. If a specified property is not present on the requested object(s), it will be ignored.", + "items" : { + "type" : "string" + } + }, + "propertiesWithHistory" : { + "type" : "array", + "description" : "An array of the property names to be returned along with their history of previous values. If a specified property is not present on the requested object(s), it will be ignored.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property." + }, + "BatchResponsePublicDefaultAssociation" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "description" : "An array of StandardError objects detailing any errors that occurred during the batch operation.", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "numErrors" : { + "type" : "integer", + "description" : "The total number of errors that occurred during the operation.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of PublicDefaultAssociation objects representing the results of the batch operation.", + "items" : { + "$ref" : "#/components/schemas/PublicDefaultAssociation" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "The response returned after performing a batch operation on associations." + }, + "BatchResponseSimplePublicObject" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch request was initially made, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of SimplePublicObject items representing the results of the batch operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing began, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. The expected value is \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "A public object batch response object" + }, + "BatchResponseSimplePublicObjectWithErrors" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "numErrors" : { + "type" : "integer", + "description" : "The number of errors encountered during the batch process.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request - \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\"", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the result of a batch operation on CRM objects, including the processing status, batch results, timestamps, and a list of any errors encountered during the operation." + }, + "BatchResponseSimplePublicUpsertObject" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of SimplePublicUpsertObject items representing the results of the batch upsert operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicUpsertObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects." + }, + "BatchResponseSimplePublicUpsertObjectWithErrors" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "numErrors" : { + "type" : "integer", + "description" : "The number of errors encountered during the batch process.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SimplePublicUpsertObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the response from a batch upsert operation, including the status, timestamps, successfully processed objects, and any errors that occurred during processing." + }, + "CollectionResponseAssociatedId" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/Paging" + }, + "results" : { + "type" : "array", + "description" : "A list of associated IDs retrieved from the API request.", + "items" : { + "$ref" : "#/components/schemas/AssociatedId" + } + } + }, + "description" : "Represents a collection of associated IDs returned by an API request, including pagination details for navigating through the results." + }, + "CollectionResponseSimplePublicObjectWithAssociationsForwardPaging" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/ForwardPaging" + }, + "results" : { + "type" : "array", + "description" : "An array of simple public objects that are included in the current page of the response. Each object may include its associated data.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations" + } + } + }, + "description" : "Represents a paginated collection response that includes simple public objects with their associations. This component is used to handle the results and pagination details when retrieving a list of objects from the API." + }, + "CollectionResponseWithTotalSimplePublicObject" : { + "required" : [ "results", "total" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/Paging" + }, + "results" : { + "type" : "array", + "description" : "An array containing the simple public objects returned in the current page of the response. This property is required.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "total" : { + "type" : "integer", + "description" : "The number of available results", + "format" : "int32" + } + }, + "description" : "Represents a list of simple objects returned from an API request, along with the total count of objects available." + }, + "Error" : { + "required" : [ "category", "correlationId", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The error category" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}" + }, + "correlationId" : { + "type" : "string", + "description" : "A unique identifier for the request. Include this value with any error reports or support tickets", + "format" : "uuid", + "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf" + }, + "errors" : { + "type" : "array", + "description" : "further information about the error", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps" + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate", + "example" : "An error occurred" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered.", + "example" : { + "message" : "Invalid input (details will vary based on the error)", + "correlationId" : "aeb5f871-7f07-4993-9211-075dc63e7cbf", + "category" : "VALIDATION_ERROR", + "links" : { + "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base" + } + } + }, + "ErrorDetail" : { + "required" : [ "message" ], + "type" : "object", + "properties" : { + "code" : { + "type" : "string", + "description" : "The status code associated with the error detail" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{missingScopes=[scope1, scope2]}" + }, + "in" : { + "type" : "string", + "description" : "The name of the field or parameter in which the error was found." + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response." + }, + "Filter" : { + "required" : [ "operator", "propertyName" ], + "type" : "object", + "properties" : { + "highValue" : { + "type" : "string", + "description" : "The upper boundary value when using ranged-based filters." + }, + "operator" : { + "type" : "string", + "description" : "The comparison operator used in the filter, such as \"EQ\" or \"GT\".", + "enum" : [ "BETWEEN", "CONTAINS_TOKEN", "EQ", "GT", "GTE", "HAS_PROPERTY", "IN", "LT", "LTE", "NEQ", "NOT_CONTAINS_TOKEN", "NOT_HAS_PROPERTY", "NOT_IN" ] + }, + "propertyName" : { + "type" : "string", + "description" : "The name of the property to apply the filter to." + }, + "value" : { + "type" : "string", + "description" : "The value to match against the property." + }, + "values" : { + "type" : "array", + "description" : "The values to match against the property.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against. " + }, + "FilterGroup" : { + "required" : [ "filters" ], + "type" : "object", + "properties" : { + "filters" : { + "type" : "array", + "description" : "A list of individual filter criteria that are applied together as a group. Each filter specifies a condition that records must meet to be included in the results.", + "items" : { + "$ref" : "#/components/schemas/Filter" + } + } + }, + "description" : "Represents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints." + }, + "ForwardPaging" : { + "type" : "object", + "properties" : { + "next" : { + "$ref" : "#/components/schemas/NextPage" + } + }, + "description" : "Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page." + }, + "LabelsBetweenObjectPair" : { + "required" : [ "fromObjectId", "fromObjectTypeId", "labels", "toObjectId", "toObjectTypeId" ], + "type" : "object", + "properties" : { + "fromObjectId" : { + "type" : "string", + "description" : "Source unique ID of the object." + }, + "fromObjectTypeId" : { + "type" : "string", + "description" : "Source object type." + }, + "labels" : { + "type" : "array", + "description" : "An array of labels that describe the relationship between the two objects. This is a required property.", + "items" : { + "type" : "string" + } + }, + "toObjectId" : { + "type" : "string", + "description" : "Target unique ID of the object." + }, + "toObjectTypeId" : { + "type" : "string", + "description" : "Target object type." + } + }, + "description" : "The relationship descriptors applicable between two object types." + }, + "NextPage" : { + "required" : [ "after" ], + "type" : "object", + "properties" : { + "after" : { + "type" : "string", + "description" : "A paging cursor token for retrieving subsequent pages." + }, + "link" : { + "type" : "string", + "description" : "A URL that can be used to retrieve the next page results." + } + }, + "description" : "Specifies the paging information needed to retrieve the next set of results in a paginated API response" + }, + "Paging" : { + "type" : "object", + "properties" : { + "next" : { + "$ref" : "#/components/schemas/NextPage" + }, + "prev" : { + "$ref" : "#/components/schemas/PreviousPage" + } + }, + "description" : "Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results." + }, + "PreviousPage" : { + "required" : [ "before" ], + "type" : "object", + "properties" : { + "before" : { + "type" : "string", + "description" : "A paging cursor token for retrieving previous pages." + }, + "link" : { + "type" : "string", + "description" : "A URL that can be used to retrieve the previous pages' results." + } + }, + "description" : "specifies the paging information needed to retrieve the previous set of results in a paginated API response" + }, + "PublicAssociationsForObject" : { + "required" : [ "to", "types" ], + "type" : "object", + "properties" : { + "to" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "types" : { + "type" : "array", + "description" : "The types of associations that exist between the object and other entities, indicating the nature of their relationship.", + "items" : { + "$ref" : "#/components/schemas/AssociationSpec" + } + } + }, + "description" : "Represents the associations for a specific object in HubSpot, detailing the types of associations and the related objects involved." + }, + "PublicDefaultAssociation" : { + "required" : [ "associationSpec", "from", "to" ], + "type" : "object", + "properties" : { + "associationSpec" : { + "$ref" : "#/components/schemas/AssociationSpec" + }, + "from" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "to" : { + "$ref" : "#/components/schemas/PublicObjectId" + } + }, + "description" : "The PublicDefaultAssociation component represents the default association configuration between two objects in HubSpot. It is used to define how objects are related to each other within the platform." + }, + "PublicGdprDeleteInput" : { + "required" : [ "objectId" ], + "type" : "object", + "properties" : { + "idProperty" : { + "type" : "string", + "description" : "The name of a property whose values are unique for this object. An alternative to identifying a contact by ID." + }, + "objectId" : { + "type" : "string", + "description" : "The ID of the contact to permanently delete." + } + }, + "description" : "An input that contains the information required to process a public GDPR data deletion request." + }, + "PublicMergeInput" : { + "required" : [ "objectIdToMerge", "primaryObjectId" ], + "type" : "object", + "properties" : { + "objectIdToMerge" : { + "type" : "string", + "description" : "The object ID of the record that the merge will not set as the current value after the merge." + }, + "primaryObjectId" : { + "type" : "string", + "description" : "The object ID of the record that the merge will generally set as the current value after the merge." + } + }, + "description" : "Input data for merging two records." + }, + "PublicObjectId" : { + "required" : [ "id" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + } + }, + "description" : "Contains the Id of a Public Object" + }, + "PublicObjectSearchRequest" : { + "required" : [ "after", "filterGroups", "limit", "properties", "sorts" ], + "type" : "object", + "properties" : { + "after" : { + "type" : "string", + "description" : "A paging cursor token for retrieving subsequent pages." + }, + "filterGroups" : { + "type" : "array", + "description" : "Up to 6 groups of filters defining additional query criteria.", + "items" : { + "$ref" : "#/components/schemas/FilterGroup" + } + }, + "limit" : { + "type" : "integer", + "description" : "The maximum results to return, up to 200 objects.", + "format" : "int32" + }, + "properties" : { + "type" : "array", + "description" : "A list of property names to include in the response.", + "items" : { + "type" : "string" + } + }, + "query" : { + "type" : "string", + "description" : "The search query string, up to 3000 characters." + }, + "sorts" : { + "type" : "array", + "description" : "Specifies sorting order based on object properties.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Describes a search request" + }, + "PublicObjectWarning" : { + "required" : [ "category", "context", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The classification of the warning, indicating the type or nature of the issue." + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Additional information or metadata about the warning, providing context for understanding the issue." + }, + "message" : { + "type" : "string", + "description" : "The text of the warning message, providing information about the issue or alert." + } + }, + "description" : "Represents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning." + }, + "SimplePublicObject" : { + "required" : [ "archived", "createdAt", "id", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used to trace the write request for the object. Set a unique ID for each write operation; it is returned with any errors so you can identify which request encountered which error." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history, each with a timestamp and source information." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL associated with the object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "A simple public object." + }, + "SimplePublicObjectBatchInput" : { + "required" : [ "id", "properties" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the contact to update. This can be the object ID, or the unique property value of the `idProperty` property." + }, + "idProperty" : { + "type" : "string", + "description" : "The name of a unique property, when identifying records by property. ", + "example" : "my_unique_property_name" + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "A unique identifier for tracing the request." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs representing the properties of the object." + } + }, + "description" : "Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties." + }, + "SimplePublicObjectBatchInputForCreate" : { + "required" : [ "associations", "properties" ], + "type" : "object", + "properties" : { + "associations" : { + "type" : "array", + "description" : "An array of associations that define the relationships between the objects being created and other existing objects. This property is required.", + "items" : { + "$ref" : "#/components/schemas/PublicAssociationsForObject" + } + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the creation or update request of the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "An input object that contains a collection of objects to be created together in a batch." + }, + "SimplePublicObjectBatchInputUpsert" : { + "required" : [ "id", "properties" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "idProperty" : { + "type" : "string", + "description" : "The name of a property whose values are unique for this object" + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier for tracing the creation request." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID." + }, + "SimplePublicObjectId" : { + "required" : [ "id" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object.", + "example" : "430001" + } + }, + "description" : "Contains the Id of a Public Object" + }, + "SimplePublicObjectInput" : { + "required" : [ "properties" ], + "type" : "object", + "properties" : { + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "Represents the input required to update a CRM object, containing an object with property names and their corresponding values." + }, + "SimplePublicObjectInputForCreate" : { + "required" : [ "associations", "properties" ], + "type" : "object", + "properties" : { + "associations" : { + "type" : "array", + "description" : "An array that specifies the relationships between the new public object and existing objects. This is required to establish how the new object is connected within the system.", + "items" : { + "$ref" : "#/components/schemas/PublicAssociationsForObject" + } + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs for setting properties for the new object." + } + }, + "description" : "Is the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects." + }, + "SimplePublicObjectWithAssociations" : { + "required" : [ "archived", "createdAt", "id", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "associations" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/CollectionResponseAssociatedId" + }, + "description" : "A map of associated object types to their associated IDs." + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the creation or update request of the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL link to access this object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type." + }, + "SimplePublicUpsertObject" : { + "required" : [ "archived", "createdAt", "id", "new", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "new" : { + "type" : "boolean", + "description" : "Whether the property is new." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier for tracing the creation request." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL associated with the object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "Represents a CRM object that has either been created or updated (upserted)" + }, + "StandardError" : { + "required" : [ "category", "context", "errors", "links", "message", "status" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The main category of the error." + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Additional context-specific information related to the error." + }, + "errors" : { + "type" : "array", + "description" : "The detailed error objects.", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "id" : { + "type" : "string", + "description" : "A unique ID for the error instance." + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "URLs linking to documentation or resources associated with the error." + }, + "message" : { + "type" : "string", + "description" : "A human-readable string describing the error and possible remediation steps." + }, + "status" : { + "type" : "string", + "description" : "A text status code for the error, typically \"error\"." + }, + "subCategory" : { + "type" : "object", + "properties" : { }, + "description" : "A more specific error category within each main category." + } + }, + "description" : "Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request." + }, + "ValueWithTimestamp" : { + "required" : [ "sourceType", "timestamp", "value" ], + "type" : "object", + "properties" : { + "sourceId" : { + "type" : "string", + "description" : "A string identifier for the specific source of the value." + }, + "sourceLabel" : { + "type" : "string", + "description" : "A human-readable label." + }, + "sourceType" : { + "type" : "string", + "description" : "A string indicating the type of source from which the value originated." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp when the property was updated, in ISO 8601 format.", + "format" : "date-time" + }, + "updatedByUserId" : { + "type" : "integer", + "description" : "The ID of the user who last updated the property.", + "format" : "int32" + }, + "value" : { + "type" : "string", + "description" : "The property value." + } + }, + "description" : "Property model that includes timestamp." + } + }, + "responses" : { + "Error" : { + "description" : "An error occurred.", + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + } + } + } + }, + "securitySchemes" : { + "developer_hapikey" : { + "type" : "apiKey", + "name" : "hapikey", + "in" : "query" + }, + "oauth2" : { + "type" : "oauth2", + "flows" : { + "authorizationCode" : { + "authorizationUrl" : "https://app.hubspot.com/oauth/authorize", + "tokenUrl" : "https://api.hubapi.com/oauth/v1/token", + "scopes" : { + "cpq.price_books.read" : "", + "crm.objects.appointments.read" : "", + "crm.objects.appointments.sensitive.read.v2" : "", + "crm.objects.appointments.sensitive.write.v2" : "", + "crm.objects.appointments.write" : "", + "crm.objects.calls.read" : "", + "crm.objects.calls.write" : "", + "crm.objects.carts.read" : "", + "crm.objects.carts.write" : "", + "crm.objects.commercepayments.read" : "", + "crm.objects.commercepayments.write" : "", + "crm.objects.companies.highly_sensitive.read.v2" : "", + "crm.objects.companies.highly_sensitive.write.v2" : "", + "crm.objects.companies.read" : "", + "crm.objects.companies.sensitive.read.v2" : "", + "crm.objects.companies.sensitive.write.v2" : "", + "crm.objects.companies.write" : "", + "crm.objects.contacts.highly_sensitive.read.v2" : "", + "crm.objects.contacts.highly_sensitive.write.v2" : "", + "crm.objects.contacts.read" : "", + "crm.objects.contacts.sensitive.read.v2" : "", + "crm.objects.contacts.sensitive.write.v2" : "", + "crm.objects.contacts.write" : "", + "crm.objects.contracts.read" : "", + "crm.objects.courses.read" : "", + "crm.objects.courses.write" : "", + "crm.objects.custom.highly_sensitive.read.v2" : "", + "crm.objects.custom.highly_sensitive.write.v2" : "", + "crm.objects.custom.read" : "", + "crm.objects.custom.sensitive.read.v2" : "", + "crm.objects.custom.sensitive.write.v2" : "", + "crm.objects.custom.write" : "", + "crm.objects.deals.highly_sensitive.read.v2" : "", + "crm.objects.deals.highly_sensitive.write.v2" : "", + "crm.objects.deals.read" : "", + "crm.objects.deals.sensitive.read.v2" : "", + "crm.objects.deals.sensitive.write.v2" : "", + "crm.objects.deals.write" : "", + "crm.objects.emails.read" : "", + "crm.objects.emails.write" : "", + "crm.objects.feedback_submissions.read" : "", + "crm.objects.forecasts.read" : "", + "crm.objects.goals.read" : "", + "crm.objects.goals.write" : "", + "crm.objects.invoices.read" : "", + "crm.objects.invoices.write" : "", + "crm.objects.leads.read" : "", + "crm.objects.leads.write" : "", + "crm.objects.line_items.read" : "", + "crm.objects.line_items.write" : "", + "crm.objects.listings.read" : "", + "crm.objects.listings.write" : "", + "crm.objects.meetings.read" : "", + "crm.objects.meetings.write" : "", + "crm.objects.notes.read" : "", + "crm.objects.notes.write" : "", + "crm.objects.orders.read" : "", + "crm.objects.orders.write" : "", + "crm.objects.partner-clients.read" : "", + "crm.objects.partner-clients.write" : "", + "crm.objects.partner-services.read" : "", + "crm.objects.partner-services.write" : "", + "crm.objects.products.read" : "", + "crm.objects.products.write" : "", + "crm.objects.projects.highly_sensitive.read" : "", + "crm.objects.projects.highly_sensitive.write" : "", + "crm.objects.projects.read" : "", + "crm.objects.projects.sensitive.read" : "", + "crm.objects.projects.sensitive.write" : "", + "crm.objects.projects.write" : "", + "crm.objects.quotes.read" : "", + "crm.objects.quotes.write" : "", + "crm.objects.services.read" : "", + "crm.objects.services.write" : "", + "crm.objects.subscriptions.read" : "", + "crm.objects.subscriptions.write" : "", + "crm.objects.tasks.read" : "", + "crm.objects.tasks.write" : "", + "crm.objects.tickets.highly_sensitive.read" : "", + "crm.objects.tickets.highly_sensitive.write" : "", + "crm.objects.tickets.read" : "", + "crm.objects.tickets.sensitive.read" : "", + "crm.objects.tickets.sensitive.write" : "", + "crm.objects.tickets.write" : "", + "crm.objects.users.read" : "", + "crm.objects.users.write" : "", + "e-commerce" : "", + "media_bridge.read" : "", + "oauth" : "", + "revenue.contracts.read" : "", + "tickets.highly_sensitive.v2" : "", + "tickets.sensitive.v2" : "" + } + } + }, + "x-hubspot-app-availability" : { + "cpq.price_books.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.appointments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.commercepayments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.commercepayments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.companies.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.contacts.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contracts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.custom.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.feedback_submissions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.forecasts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-clients.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-clients.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.products.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.products.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "e-commerce" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "media_bridge.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "oauth" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "revenue.contracts.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "tickets.highly_sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "tickets.sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + } + } + } + } + }, + "x-hubspot-available-client-libraries" : [ "Node", "Python", "Ruby", "PHP" ], + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + } +} \ No newline at end of file diff --git a/spec/hubspot/crm-owners.json b/spec/hubspot/crm-owners.json new file mode 100644 index 0000000..e383c2c --- /dev/null +++ b/spec/hubspot/crm-owners.json @@ -0,0 +1,451 @@ +{ + "openapi" : "3.0.1", + "info" : { + "title" : "Crm Owners", + "description" : "Owners - Parent pom", + "version" : "2026-03", + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + }, + "x-hubspot-api-use-case" : "Retrieve the owner IDs for all users in the account to later assign CRM records across the team.", + "x-hubspot-introduction" : "Each user in a HubSpot account is assigned an owner ID, which HubSpot uses to map the user to their assigned CRM records, activities, and more. Use the owners API to retrieve owner IDs and other related information for users in the account. To assign an owner to a CRM record, you can use the properties API to set the hubspot_owner_id property." + }, + "servers" : [ { + "url" : "https://api.hubapi.com" + } ], + "tags" : [ { + "name" : "Basic" + } ], + "paths" : { + "/crm/owners/2026-03" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "List owners", + "description" : "Retrieve a paginated list of owners from your HubSpot account. This endpoint allows filtering by email and supports pagination through the 'after' parameter. You can also specify the maximum number of results per page and choose to include archived owners in the response.", + "operationId" : "get-/crm/owners/2026-03_/crm/owners/v3", + "parameters" : [ { + "name" : "after", + "in" : "query", + "description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "email", + "in" : "query", + "description" : "Filter by email address (optional)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum number of results to display per page.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 100 + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponsePublicOwnerForwardPaging" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "automation" ] + }, { + "oauth2" : [ "crm.objects.owners.read" ] + }, { + "oauth2" : [ "crm.pipelines.approval.read" ] + }, { + "oauth2" : [ "crm.pipelines.governance.write" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/owners/2026-03/{ownerId}" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Retrieve a specific owner by ID", + "description" : "Retrieve details of a specific owner using either their 'id' or 'userId'.", + "operationId" : "get-/crm/owners/2026-03/{ownerId}_getById", + "parameters" : [ { + "name" : "ownerId", + "in" : "path", + "description" : "The unique identifier of the owner to retrieve.", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "idProperty", + "in" : "query", + "description" : "Specifies which property to use for identifying the owner. Valid values are 'id' or 'userId'. Defaults to 'id'.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "id", + "enum" : [ "id", "userId" ] + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PublicOwner" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "automation" ] + }, { + "oauth2" : [ "crm.objects.owners.read" ] + }, { + "oauth2" : [ "crm.pipelines.approval.read" ] + }, { + "oauth2" : [ "crm.pipelines.governance.write" ] + } ] + } + } + }, + "components" : { + "schemas" : { + "CollectionResponsePublicOwnerForwardPaging" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/ForwardPaging" + }, + "results" : { + "type" : "array", + "description" : "An array of PublicOwner objects, each representing an individual owner with their specific details.", + "items" : { + "$ref" : "#/components/schemas/PublicOwner" + } + } + } + }, + "Error" : { + "required" : [ "category", "correlationId", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The error category" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}" + }, + "correlationId" : { + "type" : "string", + "description" : "A unique identifier for the request. Include this value with any error reports or support tickets", + "format" : "uuid", + "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf" + }, + "errors" : { + "type" : "array", + "description" : "further information about the error", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps" + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate", + "example" : "An error occurred" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered.", + "example" : { + "message" : "Invalid input (details will vary based on the error)", + "correlationId" : "aeb5f871-7f07-4993-9211-075dc63e7cbf", + "category" : "VALIDATION_ERROR", + "links" : { + "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base" + } + } + }, + "ErrorDetail" : { + "required" : [ "message" ], + "type" : "object", + "properties" : { + "code" : { + "type" : "string", + "description" : "The status code associated with the error detail" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{missingScopes=[scope1, scope2]}" + }, + "in" : { + "type" : "string", + "description" : "The name of the field or parameter in which the error was found." + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response." + }, + "ForwardPaging" : { + "type" : "object", + "properties" : { + "next" : { + "$ref" : "#/components/schemas/NextPage" + } + }, + "description" : "Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page." + }, + "NextPage" : { + "required" : [ "after" ], + "type" : "object", + "properties" : { + "after" : { + "type" : "string", + "description" : "A string token used as a cursor for pagination, indicating the position after the last item on the current page." + }, + "link" : { + "type" : "string", + "description" : "A string containing the URL link to the next page of results." + } + }, + "description" : "Specifies the paging information needed to retrieve the next set of results in a paginated API response" + }, + "PublicOwner" : { + "required" : [ "archived", "createdAt", "id", "type", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Indicates whether the owner is archived." + }, + "createdAt" : { + "type" : "string", + "description" : "The date and time when the owner was created.", + "format" : "date-time" + }, + "email" : { + "type" : "string", + "description" : "The email address of the owner." + }, + "firstName" : { + "type" : "string", + "description" : "The first name of the owner." + }, + "id" : { + "type" : "string", + "description" : "The unique identifier of the owner." + }, + "lastName" : { + "type" : "string", + "description" : "The last name of the owner." + }, + "teams" : { + "type" : "array", + "description" : "An array of teams associated with the owner, where each team is represented by a PublicTeam object.", + "items" : { + "$ref" : "#/components/schemas/PublicTeam" + } + }, + "type" : { + "type" : "string", + "description" : "The type of the owner, which can be either PERSON or QUEUE.", + "enum" : [ "PERSON", "QUEUE" ] + }, + "updatedAt" : { + "type" : "string", + "description" : "The date and time when the owner was last updated.", + "format" : "date-time" + }, + "userId" : { + "type" : "integer", + "description" : "The user ID of the owner.", + "format" : "int32" + }, + "userIdIncludingInactive" : { + "type" : "integer", + "description" : "The user ID of the owner, including inactive users.", + "format" : "int32" + } + } + }, + "PublicTeam" : { + "required" : [ "id", "name", "primary" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique identifier for the team, represented as a string." + }, + "name" : { + "type" : "string", + "description" : "The name of the team, represented as a string." + }, + "primary" : { + "type" : "boolean", + "description" : "A boolean indicating whether this team is the primary team." + } + } + } + }, + "responses" : { + "Error" : { + "description" : "An error occurred.", + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + } + } + } + }, + "securitySchemes" : { + "developer_hapikey" : { + "type" : "apiKey", + "name" : "hapikey", + "in" : "query" + }, + "oauth2" : { + "type" : "oauth2", + "flows" : { + "authorizationCode" : { + "authorizationUrl" : "https://app.hubspot.com/oauth/authorize", + "tokenUrl" : "https://api.hubapi.com/oauth/v1/token", + "scopes" : { + "automation" : "", + "crm.objects.owners.read" : "", + "crm.pipelines.approval.read" : "", + "crm.pipelines.governance.write" : "" + } + } + }, + "x-hubspot-app-availability" : { + "automation" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.owners.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.pipelines.approval.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.pipelines.governance.write" : { + "portal" : [ "public", "private" ], + "developer" : false + } + } + } + } + }, + "x-hubspot-available-client-libraries" : [ "Node", "Python", "Ruby", "PHP" ], + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + } +} \ No newline at end of file diff --git a/spec/hubspot/deals.json b/spec/hubspot/deals.json new file mode 100644 index 0000000..ce7b4a8 --- /dev/null +++ b/spec/hubspot/deals.json @@ -0,0 +1,3160 @@ +{ + "openapi" : "3.0.1", + "info" : { + "title" : "Deals", + "description" : "Basepom for all HubSpot Projects", + "version" : "2026-03", + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + }, + "x-hubspot-api-use-case" : "When a sales rep starts working with a prospective customer, create a deal record to track the negotiation process. When the customer later makes their purchase, you can update the deal to a closed stage.", + "x-hubspot-introduction" : "Use the deals API to create and manage CRM records that represent transactions with contacts and/or companies. Deals progress through pipeline stages to reflect whether the transaction has been completed, is active, or has otherwise been lost." + }, + "servers" : [ { + "url" : "https://api.hubapi.com" + } ], + "tags" : [ { + "name" : "Basic" + }, { + "name" : "Batch" + }, { + "name" : "Search" + } ], + "paths" : { + "/crm/objects/2026-03/0-3" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "List", + "description" : "Read a page of deals. Control what is returned via the `properties` query param.", + "operationId" : "get-/crm/objects/2026-03/0-3_getPage", + "parameters" : [ { + "name" : "after", + "in" : "query", + "description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "associations", + "in" : "query", + "description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum number of results to display per page.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 10 + } + }, { + "name" : "properties", + "in" : "query", + "description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "propertiesWithHistory", + "in" : "query", + "description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponseSimplePublicObjectWithAssociationsForwardPaging" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "post" : { + "tags" : [ "Basic" ], + "summary" : "Create", + "description" : "Create a deal with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard deals is provided.", + "operationId" : "post-/crm/objects/2026-03/0-3_create", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectInputForCreate" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "headers" : { + "Location" : { + "description" : "URL of the newly created resource", + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/0-3/batch/archive" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Archive a batch of deals by ID", + "description" : "Archive multiple deals using their IDs.", + "operationId" : "post-/crm/objects/2026-03/0-3/batch/archive_archive", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectId" + } + } + }, + "required" : true + }, + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/0-3/batch/create" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Create a batch of deals", + "description" : "Create multiple deals in a single request.", + "operationId" : "post-/crm/objects/2026-03/0-3/batch/create_create", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputForCreate" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/0-3/batch/read" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Read a batch of deals by internal ID, or unique property values", + "description" : "Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ", + "operationId" : "post-/crm/objects/2026-03/0-3/batch/read_read", + "parameters" : [ { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchReadInputSimplePublicObjectId" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/0-3/batch/update" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Update a batch of deals by internal ID, or unique property values", + "description" : "Update multiple deals using their internal IDs or unique property values.", + "operationId" : "post-/crm/objects/2026-03/0-3/batch/update_update", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/0-3/batch/upsert" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Create or update a batch of deals by unique property values", + "description" : "Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.", + "operationId" : "post-/crm/objects/2026-03/0-3/batch/upsert_upsert", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputUpsert" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicUpsertObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicUpsertObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/0-3/merge" : { + "post" : { + "tags" : [ "Basic" ], + "summary" : "Merge two deals with same type", + "description" : "Combine two deals of the same type into a single deal.", + "operationId" : "post-/crm/objects/2026-03/0-3/merge_merge", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PublicMergeInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/0-3/search" : { + "post" : { + "tags" : [ "Search" ], + "summary" : "Search for deals using various filters and criteria to retrieve specific records.", + "description" : "Search for deals using specified criteria and filters.", + "operationId" : "post-/crm/objects/2026-03/0-3/search_doSearch", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PublicObjectSearchRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponseWithTotalSimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/0-3/{dealId}" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Read", + "description" : "Read an Object identified by `{dealId}`. `{dealId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.", + "operationId" : "get-/crm/objects/2026-03/0-3/{dealId}_getById", + "parameters" : [ { + "name" : "dealId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + }, { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "associations", + "in" : "query", + "description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "idProperty", + "in" : "query", + "description" : "The name of a property whose values are unique for this object type", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "properties", + "in" : "query", + "description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "propertiesWithHistory", + "in" : "query", + "description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "delete" : { + "tags" : [ "Basic" ], + "summary" : "Archive", + "description" : "Move an Object identified by `{dealId}` to the recycling bin.", + "operationId" : "delete-/crm/objects/2026-03/0-3/{dealId}_archive", + "parameters" : [ { + "name" : "dealId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "patch" : { + "tags" : [ "Basic" ], + "summary" : "Update", + "description" : "Perform a partial update of an Object identified by `{dealId}`or optionally a unique property value as specified by the `idProperty` query param. `{dealId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + "operationId" : "patch-/crm/objects/2026-03/0-3/{dealId}_update", + "parameters" : [ { + "name" : "dealId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + }, { + "name" : "idProperty", + "in" : "query", + "description" : "The name of a property whose values are unique for this object type", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}" : { + "put" : { + "tags" : [ "Batch" ], + "operationId" : "put-/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "fromObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "fromObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponsePublicDefaultAssociation" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}" : { + "put" : { + "tags" : [ "Basic" ], + "operationId" : "put-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "objectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AssociationSpec" + } + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "headers" : { + "Location" : { + "description" : "URL of the newly created resource", + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LabelsBetweenObjectPair" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "delete" : { + "tags" : [ "Basic" ], + "operationId" : "delete-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "objectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : true + } + } + } + }, + "components" : { + "schemas" : { + "AssociatedId" : { + "required" : [ "id", "type" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID for the association type." + }, + "type" : { + "type" : "string", + "description" : "The type of association.", + "example" : "deal_to_contact" + } + }, + "description" : "Contains the id and type of an association" + }, + "AssociationSpec" : { + "required" : [ "associationCategory", "associationTypeId" ], + "type" : "object", + "properties" : { + "associationCategory" : { + "type" : "string", + "description" : "The category of the association, such as \"HUBSPOT_DEFINED\".", + "enum" : [ "HUBSPOT_DEFINED", "INTEGRATOR_DEFINED", "USER_DEFINED", "WORK" ] + }, + "associationTypeId" : { + "type" : "integer", + "description" : "The ID representing the specific type of association.", + "format" : "int32" + } + }, + "description" : "Defines the type, direction, and details of the relationship between two CRM objects." + }, + "BatchInputSimplePublicObjectBatchInput" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be processed in the batch operation. Each object in the array contains the data necessary for the specific operation being performed.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInput" + } + } + }, + "description" : "Represents a batch input component used to handle multiple simple public objects in a single API request. This component is typically used when performing batch operations to create, update, or delete multiple records simultaneously." + }, + "BatchInputSimplePublicObjectBatchInputForCreate" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be created. Each object in the array contains the necessary data for creating a new entry in the system.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInputForCreate" + } + } + }, + "description" : "Represents a batch input for creating multiple simple public objects in a single request. This component is used to streamline the process of adding new objects to a HubSpot account by allowing multiple entries to be created at once." + }, + "BatchInputSimplePublicObjectBatchInputUpsert" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be upserted. Each object in the array contains the necessary data for creating or updating a record in HubSpot.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInputUpsert" + } + } + }, + "description" : "Represents a batch input operation for upserting simple public objects in HubSpot. This component is used to process multiple upsert operations in a single request, improving efficiency and performance." + }, + "BatchInputSimplePublicObjectId" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public object IDs to be processed in the batch operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectId" + } + } + }, + "description" : "Represents a batch input payload containing a list of simple public object IDs. This component is used when performing batch operations on multiple objects within HubSpot." + }, + "BatchReadInputSimplePublicObjectId" : { + "required" : [ "inputs", "properties", "propertiesWithHistory" ], + "type" : "object", + "properties" : { + "idProperty" : { + "type" : "string", + "description" : "When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID." + }, + "inputs" : { + "type" : "array", + "description" : "An array of SimplePublicObjectId objects, each containing the ID of an object to be read.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectId" + } + }, + "properties" : { + "type" : "array", + "description" : "Key-value pairs for setting properties for the new object.", + "items" : { + "type" : "string" + } + }, + "propertiesWithHistory" : { + "type" : "array", + "description" : "Key-value pairs for setting properties for the new object and their histories.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property." + }, + "BatchResponsePublicDefaultAssociation" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "description" : "An array of StandardError objects detailing any errors that occurred during the batch operation.", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "numErrors" : { + "type" : "integer", + "description" : "The total number of errors that occurred during the operation.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch request was initially made, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of PublicDefaultAssociation objects representing the results of the batch operation.", + "items" : { + "$ref" : "#/components/schemas/PublicDefaultAssociation" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing began, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request: \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\"", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "The response returned after performing a batch operation on associations." + }, + "BatchResponseSimplePublicObject" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch request was initially made, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of SimplePublicObject items representing the results of the batch operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing began, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. The expected value is \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "A public object batch response object" + }, + "BatchResponseSimplePublicObjectWithErrors" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "numErrors" : { + "type" : "integer", + "description" : "The number of errors encountered during the batch process.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request - \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\"", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the result of a batch operation on CRM objects, including the processing status, batch results, timestamps, and a list of any errors encountered during the operation." + }, + "BatchResponseSimplePublicUpsertObject" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of SimplePublicUpsertObject items representing the results of the batch upsert operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicUpsertObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. The expected value is \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects." + }, + "BatchResponseSimplePublicUpsertObjectWithErrors" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "numErrors" : { + "type" : "integer", + "description" : "The number of errors encountered during the batch process.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SimplePublicUpsertObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the response from a batch upsert operation, including the status, timestamps, successfully processed objects, and any errors that occurred during processing." + }, + "CollectionResponseAssociatedId" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/Paging" + }, + "results" : { + "type" : "array", + "description" : "A list of associated IDs retrieved from the API request.", + "items" : { + "$ref" : "#/components/schemas/AssociatedId" + } + } + }, + "description" : "Represents a collection of associated IDs returned by an API request, including pagination details for navigating through the results." + }, + "CollectionResponseSimplePublicObjectWithAssociationsForwardPaging" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/ForwardPaging" + }, + "results" : { + "type" : "array", + "description" : "An array of simple public objects that are included in the current page of the response. Each object may include its associated data.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations" + } + } + }, + "description" : "Represents a paginated collection response that includes simple public objects with their associations. This component is used to handle the results and pagination details when retrieving a list of objects from the API." + }, + "CollectionResponseWithTotalSimplePublicObject" : { + "required" : [ "results", "total" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/Paging" + }, + "results" : { + "type" : "array", + "description" : "An array containing the simple public objects returned in the current page of the response. This property is required.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "total" : { + "type" : "integer", + "description" : "The number of available results", + "format" : "int32" + } + }, + "description" : "Represents a list of simple objects returned from an API request, along with the total count of objects available." + }, + "Error" : { + "required" : [ "category", "correlationId", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The error category" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}" + }, + "correlationId" : { + "type" : "string", + "description" : "A unique identifier for the request. Include this value with any error reports or support tickets", + "format" : "uuid", + "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf" + }, + "errors" : { + "type" : "array", + "description" : "further information about the error", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps" + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate", + "example" : "An error occurred" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered.", + "example" : { + "message" : "Invalid input (details will vary based on the error)", + "correlationId" : "aeb5f871-7f07-4993-9211-075dc63e7cbf", + "category" : "VALIDATION_ERROR", + "links" : { + "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base" + } + } + }, + "ErrorDetail" : { + "required" : [ "message" ], + "type" : "object", + "properties" : { + "code" : { + "type" : "string", + "description" : "The status code associated with the error detail" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{missingScopes=[scope1, scope2]}" + }, + "in" : { + "type" : "string", + "description" : "The name of the field or parameter in which the error was found." + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response." + }, + "Filter" : { + "required" : [ "operator", "propertyName" ], + "type" : "object", + "properties" : { + "highValue" : { + "type" : "string", + "description" : "The upper boundary value when using ranged-based filters." + }, + "operator" : { + "type" : "string", + "description" : "The comparison operator used in the filter, such as \"EQ\" or \"GT\".", + "enum" : [ "BETWEEN", "CONTAINS_TOKEN", "EQ", "GT", "GTE", "HAS_PROPERTY", "IN", "LT", "LTE", "NEQ", "NOT_CONTAINS_TOKEN", "NOT_HAS_PROPERTY", "NOT_IN" ] + }, + "propertyName" : { + "type" : "string", + "description" : "The name of the property to apply the filter to." + }, + "value" : { + "type" : "string", + "description" : "The value to match against the property." + }, + "values" : { + "type" : "array", + "description" : "The values to match against the property.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against. " + }, + "FilterGroup" : { + "required" : [ "filters" ], + "type" : "object", + "properties" : { + "filters" : { + "type" : "array", + "description" : "A list of individual filter criteria that are applied together as a group. Each filter specifies a condition that records must meet to be included in the results.", + "items" : { + "$ref" : "#/components/schemas/Filter" + } + } + }, + "description" : "Represents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints." + }, + "ForwardPaging" : { + "type" : "object", + "properties" : { + "next" : { + "$ref" : "#/components/schemas/NextPage" + } + }, + "description" : "Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page." + }, + "LabelsBetweenObjectPair" : { + "required" : [ "fromObjectId", "fromObjectTypeId", "labels", "toObjectId", "toObjectTypeId" ], + "type" : "object", + "properties" : { + "fromObjectId" : { + "type" : "string", + "description" : "Source unique ID of the object." + }, + "fromObjectTypeId" : { + "type" : "string", + "description" : "Source object type." + }, + "labels" : { + "type" : "array", + "description" : "An array of labels that describe the relationship between the two objects. This is a required property.", + "items" : { + "type" : "string" + } + }, + "toObjectId" : { + "type" : "string", + "description" : "Target unique ID of the object." + }, + "toObjectTypeId" : { + "type" : "string", + "description" : "Target object type." + } + }, + "description" : "The relationship descriptors applicable between two object types." + }, + "NextPage" : { + "required" : [ "after" ], + "type" : "object", + "properties" : { + "after" : { + "type" : "string", + "description" : "A paging cursor token for retrieving subsequent pages." + }, + "link" : { + "type" : "string", + "description" : "A URL that can be used to retrieve the next page results." + } + }, + "description" : "Specifies the paging information needed to retrieve the next set of results in a paginated API response" + }, + "Paging" : { + "type" : "object", + "properties" : { + "next" : { + "$ref" : "#/components/schemas/NextPage" + }, + "prev" : { + "$ref" : "#/components/schemas/PreviousPage" + } + }, + "description" : "Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results." + }, + "PreviousPage" : { + "required" : [ "before" ], + "type" : "object", + "properties" : { + "before" : { + "type" : "string", + "description" : "A paging cursor token for retrieving previous pages." + }, + "link" : { + "type" : "string", + "description" : "A URL that can be used to retrieve the previous pages' results." + } + }, + "description" : "specifies the paging information needed to retrieve the previous set of results in a paginated API response" + }, + "PublicAssociationsForObject" : { + "required" : [ "to", "types" ], + "type" : "object", + "properties" : { + "to" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "types" : { + "type" : "array", + "description" : "The types of associations that exist between the object and other entities, indicating the nature of their relationship.", + "items" : { + "$ref" : "#/components/schemas/AssociationSpec" + } + } + }, + "description" : "Represents the associations for a specific object in HubSpot, detailing the types of associations and the related objects involved." + }, + "PublicDefaultAssociation" : { + "required" : [ "associationSpec", "from", "to" ], + "type" : "object", + "properties" : { + "associationSpec" : { + "$ref" : "#/components/schemas/AssociationSpec" + }, + "from" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "to" : { + "$ref" : "#/components/schemas/PublicObjectId" + } + }, + "description" : "The PublicDefaultAssociation component represents the default association configuration between two objects in HubSpot. It is used to define how objects are related to each other within the platform." + }, + "PublicMergeInput" : { + "required" : [ "objectIdToMerge", "primaryObjectId" ], + "type" : "object", + "properties" : { + "objectIdToMerge" : { + "type" : "string", + "description" : "The ID of the object that will be merged into the primary object." + }, + "primaryObjectId" : { + "type" : "string", + "description" : "The ID of the object that will remain after the merge." + } + }, + "description" : "Input data for merging two records." + }, + "PublicObjectId" : { + "required" : [ "id" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + } + }, + "description" : "Contains the Id of a Public Object" + }, + "PublicObjectSearchRequest" : { + "required" : [ "after", "filterGroups", "limit", "properties", "sorts" ], + "type" : "object", + "properties" : { + "after" : { + "type" : "string", + "description" : "A paging cursor token for retrieving subsequent pages." + }, + "filterGroups" : { + "type" : "array", + "description" : "Up to 6 groups of filters defining additional query criteria.", + "items" : { + "$ref" : "#/components/schemas/FilterGroup" + } + }, + "limit" : { + "type" : "integer", + "description" : "The maximum results to return, up to 200 objects.", + "format" : "int32" + }, + "properties" : { + "type" : "array", + "description" : "A list of property names to include in the response.", + "items" : { + "type" : "string" + } + }, + "query" : { + "type" : "string", + "description" : "The search query string, up to 3000 characters." + }, + "sorts" : { + "type" : "array", + "description" : "Specifies sorting order based on object properties.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Describes a search request" + }, + "PublicObjectWarning" : { + "required" : [ "category", "context", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The classification of the warning, indicating the type or nature of the issue." + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Additional information or metadata about the warning, providing context for understanding the issue." + }, + "message" : { + "type" : "string", + "description" : "The text of the warning message, providing information about the issue or alert." + } + }, + "description" : "Represents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning." + }, + "SimplePublicObject" : { + "required" : [ "archived", "createdAt", "id", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the creation or update request of the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL associated with the object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "A simple public object." + }, + "SimplePublicObjectBatchInput" : { + "required" : [ "id", "properties" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id to be updated. This can be the object id, or the unique property value of the idProperty property" + }, + "idProperty" : { + "type" : "string", + "description" : "The name of a property whose values are unique for this object", + "example" : "my_unique_property_name" + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "A unique identifier for tracing the request." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs representing the properties of the object." + } + }, + "description" : "Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties." + }, + "SimplePublicObjectBatchInputForCreate" : { + "required" : [ "associations", "properties" ], + "type" : "object", + "properties" : { + "associations" : { + "type" : "array", + "description" : "An array of associations that define the relationships between the objects being created and other existing objects. This property is required.", + "items" : { + "$ref" : "#/components/schemas/PublicAssociationsForObject" + } + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the creation or update request of the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "An input object that contains a collection of objects to be created together in a batch." + }, + "SimplePublicObjectBatchInputUpsert" : { + "required" : [ "id", "properties" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "idProperty" : { + "type" : "string", + "description" : "The name of a property whose values are unique for this object" + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier for tracing the creation request." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID." + }, + "SimplePublicObjectId" : { + "required" : [ "id" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object.", + "example" : "430001" + } + }, + "description" : "Contains the Id of a Public Object" + }, + "SimplePublicObjectInput" : { + "required" : [ "properties" ], + "type" : "object", + "properties" : { + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "Represents the input required to update a CRM object, containing an object with property names and their corresponding values." + }, + "SimplePublicObjectInputForCreate" : { + "required" : [ "associations", "properties" ], + "type" : "object", + "properties" : { + "associations" : { + "type" : "array", + "description" : "An array that specifies the relationships between the new public object and existing objects. This is required to establish how the new object is connected within the system.", + "items" : { + "$ref" : "#/components/schemas/PublicAssociationsForObject" + } + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs for setting properties for the new object." + } + }, + "description" : "Is the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects." + }, + "SimplePublicObjectWithAssociations" : { + "required" : [ "archived", "createdAt", "id", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "associations" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/CollectionResponseAssociatedId" + }, + "description" : "A list defining relationships with other objects." + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the creation or update request of the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL link to access this object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type." + }, + "SimplePublicUpsertObject" : { + "required" : [ "archived", "createdAt", "id", "new", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "new" : { + "type" : "boolean", + "description" : "Whether the object is created." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the creation or update request of the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL associated with the object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "Represents a CRM object that has either been created or updated (upserted)" + }, + "StandardError" : { + "required" : [ "category", "context", "errors", "links", "message", "status" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The main category of the error." + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Additional context-specific information related to the error." + }, + "errors" : { + "type" : "array", + "description" : "The detailed error objects.", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "id" : { + "type" : "string", + "description" : "A unique ID for the error instance." + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "URLs linking to documentation or resources associated with the error." + }, + "message" : { + "type" : "string", + "description" : "A human-readable string describing the error and possible remediation steps." + }, + "status" : { + "type" : "string", + "description" : "The HTTP status code associated with the error." + }, + "subCategory" : { + "type" : "object", + "properties" : { }, + "description" : "A more specific error category within each main category." + } + }, + "description" : "Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request." + }, + "ValueWithTimestamp" : { + "required" : [ "sourceType", "timestamp", "value" ], + "type" : "object", + "properties" : { + "sourceId" : { + "type" : "string", + "description" : "The unique ID of the property." + }, + "sourceLabel" : { + "type" : "string", + "description" : "A human-readable label." + }, + "sourceType" : { + "type" : "string", + "description" : "The property type." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp when the property was updated, in ISO 8601 format.", + "format" : "date-time" + }, + "updatedByUserId" : { + "type" : "integer", + "description" : "The ID of the user who last updated the property.", + "format" : "int32" + }, + "value" : { + "type" : "string", + "description" : "The property value." + } + }, + "description" : "Property model that includes timestamp." + } + }, + "responses" : { + "Error" : { + "description" : "An error occurred.", + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + } + } + } + }, + "securitySchemes" : { + "developer_hapikey" : { + "type" : "apiKey", + "name" : "hapikey", + "in" : "query" + }, + "oauth2" : { + "type" : "oauth2", + "flows" : { + "authorizationCode" : { + "authorizationUrl" : "https://app.hubspot.com/oauth/authorize", + "tokenUrl" : "https://api.hubapi.com/oauth/v1/token", + "scopes" : { + "cpq.price_books.read" : "", + "crm.objects.appointments.read" : "", + "crm.objects.appointments.sensitive.read.v2" : "", + "crm.objects.appointments.sensitive.write.v2" : "", + "crm.objects.appointments.write" : "", + "crm.objects.calls.read" : "", + "crm.objects.calls.write" : "", + "crm.objects.carts.read" : "", + "crm.objects.carts.write" : "", + "crm.objects.commercepayments.read" : "", + "crm.objects.commercepayments.write" : "", + "crm.objects.companies.highly_sensitive.read.v2" : "", + "crm.objects.companies.highly_sensitive.write.v2" : "", + "crm.objects.companies.read" : "", + "crm.objects.companies.sensitive.read.v2" : "", + "crm.objects.companies.sensitive.write.v2" : "", + "crm.objects.companies.write" : "", + "crm.objects.contacts.highly_sensitive.read.v2" : "", + "crm.objects.contacts.highly_sensitive.write.v2" : "", + "crm.objects.contacts.read" : "", + "crm.objects.contacts.sensitive.read.v2" : "", + "crm.objects.contacts.sensitive.write.v2" : "", + "crm.objects.contacts.write" : "", + "crm.objects.contracts.read" : "", + "crm.objects.courses.read" : "", + "crm.objects.courses.write" : "", + "crm.objects.custom.highly_sensitive.read.v2" : "", + "crm.objects.custom.highly_sensitive.write.v2" : "", + "crm.objects.custom.read" : "", + "crm.objects.custom.sensitive.read.v2" : "", + "crm.objects.custom.sensitive.write.v2" : "", + "crm.objects.custom.write" : "", + "crm.objects.deals.highly_sensitive.read.v2" : "", + "crm.objects.deals.highly_sensitive.write.v2" : "", + "crm.objects.deals.read" : "", + "crm.objects.deals.sensitive.read.v2" : "", + "crm.objects.deals.sensitive.write.v2" : "", + "crm.objects.deals.write" : "", + "crm.objects.emails.read" : "", + "crm.objects.emails.write" : "", + "crm.objects.feedback_submissions.read" : "", + "crm.objects.forecasts.read" : "", + "crm.objects.goals.read" : "", + "crm.objects.goals.write" : "", + "crm.objects.invoices.read" : "", + "crm.objects.invoices.write" : "", + "crm.objects.leads.read" : "", + "crm.objects.leads.write" : "", + "crm.objects.line_items.read" : "", + "crm.objects.line_items.write" : "", + "crm.objects.listings.read" : "", + "crm.objects.listings.write" : "", + "crm.objects.meetings.read" : "", + "crm.objects.meetings.write" : "", + "crm.objects.notes.read" : "", + "crm.objects.notes.write" : "", + "crm.objects.orders.read" : "", + "crm.objects.orders.write" : "", + "crm.objects.partner-clients.read" : "", + "crm.objects.partner-clients.write" : "", + "crm.objects.partner-services.read" : "", + "crm.objects.partner-services.write" : "", + "crm.objects.products.read" : "", + "crm.objects.products.write" : "", + "crm.objects.projects.highly_sensitive.read" : "", + "crm.objects.projects.highly_sensitive.write" : "", + "crm.objects.projects.read" : "", + "crm.objects.projects.sensitive.read" : "", + "crm.objects.projects.sensitive.write" : "", + "crm.objects.projects.write" : "", + "crm.objects.quotes.read" : "", + "crm.objects.quotes.write" : "", + "crm.objects.services.read" : "", + "crm.objects.services.write" : "", + "crm.objects.subscriptions.read" : "", + "crm.objects.subscriptions.write" : "", + "crm.objects.tasks.read" : "", + "crm.objects.tasks.write" : "", + "crm.objects.tickets.highly_sensitive.read" : "", + "crm.objects.tickets.highly_sensitive.write" : "", + "crm.objects.tickets.read" : "", + "crm.objects.tickets.sensitive.read" : "", + "crm.objects.tickets.sensitive.write" : "", + "crm.objects.tickets.write" : "", + "crm.objects.users.read" : "", + "crm.objects.users.write" : "", + "e-commerce" : "", + "media_bridge.read" : "", + "oauth" : "", + "revenue.contracts.read" : "", + "tickets.highly_sensitive.v2" : "", + "tickets.sensitive.v2" : "" + } + } + }, + "x-hubspot-app-availability" : { + "cpq.price_books.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.appointments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.commercepayments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.commercepayments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.companies.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.contacts.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contracts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.custom.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.feedback_submissions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.forecasts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-clients.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-clients.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.products.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.products.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "e-commerce" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "media_bridge.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "oauth" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "revenue.contracts.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "tickets.highly_sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "tickets.sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + } + } + } + } + }, + "x-hubspot-available-client-libraries" : [ "Node", "Python", "Ruby", "PHP" ], + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + } +} \ No newline at end of file diff --git a/spec/hubspot/emails.json b/spec/hubspot/emails.json new file mode 100644 index 0000000..6141360 --- /dev/null +++ b/spec/hubspot/emails.json @@ -0,0 +1,3106 @@ +{ + "openapi" : "3.0.1", + "info" : { + "title" : "Emails", + "description" : "Basepom for all HubSpot Projects", + "version" : "2026-03", + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + }, + "x-hubspot-api-use-case" : "You send and manage emails to your customers using a third-party email provider, and you want to programmatically log your email data to the associated records in your HubSpot account.", + "x-hubspot-introduction" : "Use the email engagements API to associate emails with records in your CRM. You can include various metadata fields as needed, including the email's headers, subject line, and body." + }, + "servers" : [ { + "url" : "https://api.hubapi.com" + } ], + "tags" : [ { + "name" : "Basic" + }, { + "name" : "Batch" + }, { + "name" : "Search" + } ], + "paths" : { + "/crm/objects/2026-03/emails" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "List", + "description" : "Read a page of emails. Control what is returned via the `properties` query param.", + "operationId" : "get-/crm/objects/2026-03/emails_getPage", + "parameters" : [ { + "name" : "after", + "in" : "query", + "description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "associations", + "in" : "query", + "description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum number of results to display per page.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 10 + } + }, { + "name" : "properties", + "in" : "query", + "description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "propertiesWithHistory", + "in" : "query", + "description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponseSimplePublicObjectWithAssociationsForwardPaging" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "post" : { + "tags" : [ "Basic" ], + "summary" : "Create", + "description" : "Create a email with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard emails is provided.", + "operationId" : "post-/crm/objects/2026-03/emails_create", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectInputForCreate" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "headers" : { + "Location" : { + "description" : "URL of the newly created resource", + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/emails/batch/archive" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Archive a batch of emails by ID", + "description" : "Archive a batch of emails identified by their IDs.", + "operationId" : "post-/crm/objects/2026-03/emails/batch/archive_archive", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectId" + } + } + }, + "required" : true + }, + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/emails/batch/create" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Create a batch of emails", + "description" : "Create a batch of emails with specified properties and return the created objects.", + "operationId" : "post-/crm/objects/2026-03/emails/batch/create_create", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputForCreate" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/emails/batch/read" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Read a batch of emails by internal ID, or unique property values", + "description" : "Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ", + "operationId" : "post-/crm/objects/2026-03/emails/batch/read_read", + "parameters" : [ { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchReadInputSimplePublicObjectId" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/emails/batch/update" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Update a batch of emails by internal ID, or unique property values", + "description" : "Update a batch of emails using their internal IDs or unique property values.", + "operationId" : "post-/crm/objects/2026-03/emails/batch/update_update", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/emails/batch/upsert" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Create or update a batch of emails by unique property values", + "description" : "Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.", + "operationId" : "post-/crm/objects/2026-03/emails/batch/upsert_upsert", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputUpsert" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicUpsertObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicUpsertObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/emails/search" : { + "post" : { + "tags" : [ "Search" ], + "summary" : "Search for emails using specified criteria and filters.", + "description" : "Perform a search for emails based on the provided query parameters and return matching results.", + "operationId" : "post-/crm/objects/2026-03/emails/search_doSearch", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PublicObjectSearchRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponseWithTotalSimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/emails/{emailId}" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Read", + "description" : "Read an Object identified by `{emailId}`. `{emailId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.", + "operationId" : "get-/crm/objects/2026-03/emails/{emailId}_getById", + "parameters" : [ { + "name" : "emailId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + }, { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "associations", + "in" : "query", + "description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "idProperty", + "in" : "query", + "description" : "The name of a property whose values are unique for this object type", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "properties", + "in" : "query", + "description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "propertiesWithHistory", + "in" : "query", + "description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "delete" : { + "tags" : [ "Basic" ], + "summary" : "Archive", + "description" : "Move an Object identified by `{emailId}` to the recycling bin.", + "operationId" : "delete-/crm/objects/2026-03/emails/{emailId}_archive", + "parameters" : [ { + "name" : "emailId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "patch" : { + "tags" : [ "Basic" ], + "summary" : "Update", + "description" : "Perform a partial update of an Object identified by `{emailId}`or optionally a unique property value as specified by the `idProperty` query param. `{emailId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + "operationId" : "patch-/crm/objects/2026-03/emails/{emailId}_update", + "parameters" : [ { + "name" : "emailId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + }, { + "name" : "idProperty", + "in" : "query", + "description" : "The name of a property whose values are unique for this object type", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}" : { + "put" : { + "tags" : [ "Batch" ], + "operationId" : "put-/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "fromObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "fromObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponsePublicDefaultAssociation" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}" : { + "put" : { + "tags" : [ "Basic" ], + "operationId" : "put-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "objectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AssociationSpec" + } + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "headers" : { + "Location" : { + "description" : "URL of the newly created resource", + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LabelsBetweenObjectPair" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "delete" : { + "tags" : [ "Basic" ], + "operationId" : "delete-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "objectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : true + } + } + } + }, + "components" : { + "schemas" : { + "AssociatedId" : { + "required" : [ "id", "type" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique identifier for the associated object." + }, + "type" : { + "type" : "string", + "description" : "The type of associations.", + "example" : "deal_to_contact" + } + }, + "description" : "Contains the id and type of an association" + }, + "AssociationSpec" : { + "required" : [ "associationCategory", "associationTypeId" ], + "type" : "object", + "properties" : { + "associationCategory" : { + "type" : "string", + "description" : "The category of the association, indicating its origin or purpose. Valid values include \"HUBSPOT_DEFINED\", \"USER_DEFINED\", \"INTEGRATOR_DEFINED\", and \"WORK\".", + "enum" : [ "HUBSPOT_DEFINED", "INTEGRATOR_DEFINED", "USER_DEFINED", "WORK" ] + }, + "associationTypeId" : { + "type" : "integer", + "description" : "An integer representing the unique identifier for the type of association.", + "format" : "int32" + } + }, + "description" : "Defines the type, direction, and details of the relationship between two CRM objects." + }, + "BatchInputSimplePublicObjectBatchInput" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be processed in the batch operation. Each object in the array contains the data necessary for the specific operation being performed.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInput" + } + } + }, + "description" : "Represents a batch input component used to handle multiple simple public objects in a single API request. This component is typically used when performing batch operations to create, update, or delete multiple records simultaneously." + }, + "BatchInputSimplePublicObjectBatchInputForCreate" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be created. Each object in the array contains the necessary data for creating a new entry in the system.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInputForCreate" + } + } + }, + "description" : "Represents a batch input for creating multiple simple public objects in a single request. This component is used to streamline the process of adding new objects to a HubSpot account by allowing multiple entries to be created at once." + }, + "BatchInputSimplePublicObjectBatchInputUpsert" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be upserted. Each object in the array contains the necessary data for creating or updating a record in HubSpot.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInputUpsert" + } + } + }, + "description" : "Represents a batch input operation for upserting simple public objects in HubSpot. This component is used to process multiple upsert operations in a single request, improving efficiency and performance." + }, + "BatchInputSimplePublicObjectId" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public object IDs to be processed in the batch operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectId" + } + } + }, + "description" : "Represents a batch input payload containing a list of simple public object IDs. This component is used when performing batch operations on multiple objects within HubSpot." + }, + "BatchReadInputSimplePublicObjectId" : { + "required" : [ "inputs", "properties", "propertiesWithHistory" ], + "type" : "object", + "properties" : { + "idProperty" : { + "type" : "string", + "description" : "When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID." + }, + "inputs" : { + "type" : "array", + "description" : "An array of SimplePublicObjectId objects, each containing the ID of an object to be read.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectId" + } + }, + "properties" : { + "type" : "array", + "description" : "An array of the property names to be returned in the response. If a specified property is not present on the requested object(s), it will be ignored.", + "items" : { + "type" : "string" + } + }, + "propertiesWithHistory" : { + "type" : "array", + "description" : "An array of the property names to be returned along with their history of previous values. If a specified property is not present on the requested object(s), it will be ignored.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property." + }, + "BatchResponsePublicDefaultAssociation" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "description" : "An array of StandardError objects detailing any errors that occurred during the batch operation.", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "numErrors" : { + "type" : "integer", + "description" : "The total number of errors that occurred during the operation.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of PublicDefaultAssociation objects representing the results of the batch operation.", + "items" : { + "$ref" : "#/components/schemas/PublicDefaultAssociation" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "The response returned after performing a batch operation on associations." + }, + "BatchResponseSimplePublicObject" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch request was initially made, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of SimplePublicObject items representing the results of the batch operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing began, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request: \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\"", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "A public object batch response object" + }, + "BatchResponseSimplePublicObjectWithErrors" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "numErrors" : { + "type" : "integer", + "description" : "The number of errors encountered during the batch process.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request - \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\"", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the result of a batch operation on CRM objects, including the processing status, batch results, timestamps, and a list of any errors encountered during the operation." + }, + "BatchResponseSimplePublicUpsertObject" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of SimplePublicUpsertObject items representing the results of the batch upsert operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicUpsertObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects." + }, + "BatchResponseSimplePublicUpsertObjectWithErrors" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "numErrors" : { + "type" : "integer", + "description" : "The number of errors encountered during the batch process.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SimplePublicUpsertObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the response from a batch upsert operation, including the status, timestamps, successfully processed objects, and any errors that occurred during processing." + }, + "CollectionResponseAssociatedId" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/Paging" + }, + "results" : { + "type" : "array", + "description" : "A list of associated IDs retrieved from the API request.", + "items" : { + "$ref" : "#/components/schemas/AssociatedId" + } + } + }, + "description" : "Represents a collection of associated IDs returned by an API request, including pagination details for navigating through the results." + }, + "CollectionResponseSimplePublicObjectWithAssociationsForwardPaging" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/ForwardPaging" + }, + "results" : { + "type" : "array", + "description" : "An array of simple public objects that are included in the current page of the response. Each object may include its associated data.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations" + } + } + }, + "description" : "Represents a paginated collection response that includes simple public objects with their associations. This component is used to handle the results and pagination details when retrieving a list of objects from the API." + }, + "CollectionResponseWithTotalSimplePublicObject" : { + "required" : [ "results", "total" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/Paging" + }, + "results" : { + "type" : "array", + "description" : "An array containing the simple public objects returned in the current page of the response. This property is required.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "total" : { + "type" : "integer", + "description" : "The number of available results", + "format" : "int32" + } + }, + "description" : "Represents a list of simple objects returned from an API request, along with the total count of objects available." + }, + "Error" : { + "required" : [ "category", "correlationId", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The error category" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}" + }, + "correlationId" : { + "type" : "string", + "description" : "A unique identifier for the request. Include this value with any error reports or support tickets", + "format" : "uuid", + "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf" + }, + "errors" : { + "type" : "array", + "description" : "further information about the error", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps" + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate", + "example" : "An error occurred" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered.", + "example" : { + "message" : "Invalid input (details will vary based on the error)", + "correlationId" : "aeb5f871-7f07-4993-9211-075dc63e7cbf", + "category" : "VALIDATION_ERROR", + "links" : { + "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base" + } + } + }, + "ErrorDetail" : { + "required" : [ "message" ], + "type" : "object", + "properties" : { + "code" : { + "type" : "string", + "description" : "The status code associated with the error detail" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{missingScopes=[scope1, scope2]}" + }, + "in" : { + "type" : "string", + "description" : "The name of the field or parameter in which the error was found." + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response." + }, + "Filter" : { + "required" : [ "operator", "propertyName" ], + "type" : "object", + "properties" : { + "highValue" : { + "type" : "string", + "description" : "The upper boundary value when using ranged-based filters." + }, + "operator" : { + "type" : "string", + "description" : "The comparison operator used in the filter, such as \"EQ\" or \"GT\".", + "enum" : [ "BETWEEN", "CONTAINS_TOKEN", "EQ", "GT", "GTE", "HAS_PROPERTY", "IN", "LT", "LTE", "NEQ", "NOT_CONTAINS_TOKEN", "NOT_HAS_PROPERTY", "NOT_IN" ] + }, + "propertyName" : { + "type" : "string", + "description" : "The name of the property to apply the filter to." + }, + "value" : { + "type" : "string", + "description" : "The value to match against the property." + }, + "values" : { + "type" : "array", + "description" : "The values to match against the property.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against. " + }, + "FilterGroup" : { + "required" : [ "filters" ], + "type" : "object", + "properties" : { + "filters" : { + "type" : "array", + "description" : "A list of individual filter criteria that are applied together as a group. Each filter specifies a condition that records must meet to be included in the results.", + "items" : { + "$ref" : "#/components/schemas/Filter" + } + } + }, + "description" : "Represents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints." + }, + "ForwardPaging" : { + "type" : "object", + "properties" : { + "next" : { + "$ref" : "#/components/schemas/NextPage" + } + }, + "description" : "Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page." + }, + "LabelsBetweenObjectPair" : { + "required" : [ "fromObjectId", "fromObjectTypeId", "labels", "toObjectId", "toObjectTypeId" ], + "type" : "object", + "properties" : { + "fromObjectId" : { + "type" : "string", + "description" : "Source unique ID of the object." + }, + "fromObjectTypeId" : { + "type" : "string", + "description" : "Source object type." + }, + "labels" : { + "type" : "array", + "description" : "An array of labels that describe the relationship between the two objects. This is a required property.", + "items" : { + "type" : "string" + } + }, + "toObjectId" : { + "type" : "string", + "description" : "Target unique ID of the object." + }, + "toObjectTypeId" : { + "type" : "string", + "description" : "Target object type." + } + }, + "description" : "The relationship descriptors applicable between two object types." + }, + "NextPage" : { + "required" : [ "after" ], + "type" : "object", + "properties" : { + "after" : { + "type" : "string", + "description" : "A paging cursor token for retrieving subsequent pages." + }, + "link" : { + "type" : "string", + "description" : "A URL that can be used to retrieve the next page results." + } + }, + "description" : "Specifies the paging information needed to retrieve the next set of results in a paginated API response" + }, + "Paging" : { + "type" : "object", + "properties" : { + "next" : { + "$ref" : "#/components/schemas/NextPage" + }, + "prev" : { + "$ref" : "#/components/schemas/PreviousPage" + } + }, + "description" : "Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results." + }, + "PreviousPage" : { + "required" : [ "before" ], + "type" : "object", + "properties" : { + "before" : { + "type" : "string", + "description" : "A paging cursor token for retrieving previous pages." + }, + "link" : { + "type" : "string", + "description" : "A URL that can be used to retrieve the previous pages' results." + } + }, + "description" : "specifies the paging information needed to retrieve the previous set of results in a paginated API response" + }, + "PublicAssociationsForObject" : { + "required" : [ "to", "types" ], + "type" : "object", + "properties" : { + "to" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "types" : { + "type" : "array", + "description" : "The types of associations that exist between the object and other entities, indicating the nature of their relationship.", + "items" : { + "$ref" : "#/components/schemas/AssociationSpec" + } + } + }, + "description" : "Represents the associations for a specific object in HubSpot, detailing the types of associations and the related objects involved." + }, + "PublicDefaultAssociation" : { + "required" : [ "associationSpec", "from", "to" ], + "type" : "object", + "properties" : { + "associationSpec" : { + "$ref" : "#/components/schemas/AssociationSpec" + }, + "from" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "to" : { + "$ref" : "#/components/schemas/PublicObjectId" + } + }, + "description" : "The PublicDefaultAssociation component represents the default association configuration between two objects in HubSpot. It is used to define how objects are related to each other within the platform." + }, + "PublicObjectId" : { + "required" : [ "id" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + } + }, + "description" : "Contains the Id of a Public Object" + }, + "PublicObjectSearchRequest" : { + "required" : [ "after", "filterGroups", "limit", "properties", "sorts" ], + "type" : "object", + "properties" : { + "after" : { + "type" : "string", + "description" : "A paging cursor token for retrieving subsequent pages." + }, + "filterGroups" : { + "type" : "array", + "description" : "Up to 6 groups of filters defining additional query criteria.", + "items" : { + "$ref" : "#/components/schemas/FilterGroup" + } + }, + "limit" : { + "type" : "integer", + "description" : "The maximum results to return, up to 200 objects.", + "format" : "int32" + }, + "properties" : { + "type" : "array", + "description" : "A list of property names to include in the response.", + "items" : { + "type" : "string" + } + }, + "query" : { + "type" : "string", + "description" : "The search query string, up to 3000 characters." + }, + "sorts" : { + "type" : "array", + "description" : "Specifies sorting order based on object properties.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Describes a search request" + }, + "PublicObjectWarning" : { + "required" : [ "category", "context", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The classification of the warning, indicating the type or nature of the issue." + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Additional information or metadata about the warning, providing context for understanding the issue." + }, + "message" : { + "type" : "string", + "description" : "The text of the warning message, providing information about the issue or alert." + } + }, + "description" : "Represents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning." + }, + "SimplePublicObject" : { + "required" : [ "archived", "createdAt", "id", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used to trace the write request for the object. Set a unique ID for each write operation; it is returned with any errors so you can identify which request encountered which error." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history, each with a timestamp and source information." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL associated with the object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "A simple public object." + }, + "SimplePublicObjectBatchInput" : { + "required" : [ "id", "properties" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id to be updated. This can be the object id, or the unique property value of the idProperty property" + }, + "idProperty" : { + "type" : "string", + "description" : "The name of a property whose values are unique for this object", + "example" : "my_unique_property_name" + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "A unique identifier for tracing the request." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs representing the properties of the object." + } + }, + "description" : "Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties." + }, + "SimplePublicObjectBatchInputForCreate" : { + "required" : [ "associations", "properties" ], + "type" : "object", + "properties" : { + "associations" : { + "type" : "array", + "description" : "An array of associations that define the relationships between the objects being created and other existing objects. This property is required.", + "items" : { + "$ref" : "#/components/schemas/PublicAssociationsForObject" + } + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the creation or update request of the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "An input object that contains a collection of objects to be created together in a batch." + }, + "SimplePublicObjectBatchInputUpsert" : { + "required" : [ "id", "properties" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "idProperty" : { + "type" : "string", + "description" : "The name of a property whose values are unique for this object" + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier for tracing the creation request." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID." + }, + "SimplePublicObjectId" : { + "required" : [ "id" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object.", + "example" : "430001" + } + }, + "description" : "Contains the Id of a Public Object" + }, + "SimplePublicObjectInput" : { + "required" : [ "properties" ], + "type" : "object", + "properties" : { + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "Represents the input required to update a CRM object, containing an object with property names and their corresponding values." + }, + "SimplePublicObjectInputForCreate" : { + "required" : [ "associations", "properties" ], + "type" : "object", + "properties" : { + "associations" : { + "type" : "array", + "description" : "An array that specifies the relationships between the new public object and existing objects. This is required to establish how the new object is connected within the system.", + "items" : { + "$ref" : "#/components/schemas/PublicAssociationsForObject" + } + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs for setting properties for the new object." + } + }, + "description" : "Is the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects." + }, + "SimplePublicObjectWithAssociations" : { + "required" : [ "archived", "createdAt", "id", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "associations" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/CollectionResponseAssociatedId" + }, + "description" : "A map of associated object types to their associated IDs." + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the creation or update request of the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL link to access this object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type." + }, + "SimplePublicUpsertObject" : { + "required" : [ "archived", "createdAt", "id", "new", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "new" : { + "type" : "boolean", + "description" : "Whether the property is new." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the write request for the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL associated with the object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "Represents a CRM object that has either been created or updated (upserted)" + }, + "StandardError" : { + "required" : [ "category", "context", "errors", "links", "message", "status" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The main category of the error." + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Additional context-specific information related to the error." + }, + "errors" : { + "type" : "array", + "description" : "The detailed error objects.", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "id" : { + "type" : "string", + "description" : "A unique ID for the error instance." + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "URLs linking to documentation or resources associated with the error." + }, + "message" : { + "type" : "string", + "description" : "A human-readable string describing the error and possible remediation steps." + }, + "status" : { + "type" : "string", + "description" : "A text status code for the error, typically \"error\"." + }, + "subCategory" : { + "type" : "object", + "properties" : { }, + "description" : "A more specific error category within each main category." + } + }, + "description" : "Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request." + }, + "ValueWithTimestamp" : { + "required" : [ "sourceType", "timestamp", "value" ], + "type" : "object", + "properties" : { + "sourceId" : { + "type" : "string", + "description" : "A string identifier for the specific source of the value." + }, + "sourceLabel" : { + "type" : "string", + "description" : "A human-readable label." + }, + "sourceType" : { + "type" : "string", + "description" : "A string indicating the type of source from which the value originated." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp when the property was updated, in ISO 8601 format.", + "format" : "date-time" + }, + "updatedByUserId" : { + "type" : "integer", + "description" : "The ID of the user who last updated the property.", + "format" : "int32" + }, + "value" : { + "type" : "string", + "description" : "The property value." + } + }, + "description" : "Property model that includes timestamp." + } + }, + "responses" : { + "Error" : { + "description" : "An error occurred.", + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + } + } + } + }, + "securitySchemes" : { + "developer_hapikey" : { + "type" : "apiKey", + "name" : "hapikey", + "in" : "query" + }, + "oauth2" : { + "type" : "oauth2", + "flows" : { + "authorizationCode" : { + "authorizationUrl" : "https://app.hubspot.com/oauth/authorize", + "tokenUrl" : "https://api.hubapi.com/oauth/v1/token", + "scopes" : { + "cpq.price_books.read" : "", + "crm.objects.appointments.read" : "", + "crm.objects.appointments.sensitive.read.v2" : "", + "crm.objects.appointments.sensitive.write.v2" : "", + "crm.objects.appointments.write" : "", + "crm.objects.calls.read" : "", + "crm.objects.calls.write" : "", + "crm.objects.carts.read" : "", + "crm.objects.carts.write" : "", + "crm.objects.commercepayments.read" : "", + "crm.objects.commercepayments.write" : "", + "crm.objects.companies.highly_sensitive.read.v2" : "", + "crm.objects.companies.highly_sensitive.write.v2" : "", + "crm.objects.companies.read" : "", + "crm.objects.companies.sensitive.read.v2" : "", + "crm.objects.companies.sensitive.write.v2" : "", + "crm.objects.companies.write" : "", + "crm.objects.contacts.highly_sensitive.read.v2" : "", + "crm.objects.contacts.highly_sensitive.write.v2" : "", + "crm.objects.contacts.read" : "", + "crm.objects.contacts.sensitive.read.v2" : "", + "crm.objects.contacts.sensitive.write.v2" : "", + "crm.objects.contacts.write" : "", + "crm.objects.contracts.read" : "", + "crm.objects.courses.read" : "", + "crm.objects.courses.write" : "", + "crm.objects.custom.highly_sensitive.read.v2" : "", + "crm.objects.custom.highly_sensitive.write.v2" : "", + "crm.objects.custom.read" : "", + "crm.objects.custom.sensitive.read.v2" : "", + "crm.objects.custom.sensitive.write.v2" : "", + "crm.objects.custom.write" : "", + "crm.objects.deals.highly_sensitive.read.v2" : "", + "crm.objects.deals.highly_sensitive.write.v2" : "", + "crm.objects.deals.read" : "", + "crm.objects.deals.sensitive.read.v2" : "", + "crm.objects.deals.sensitive.write.v2" : "", + "crm.objects.deals.write" : "", + "crm.objects.emails.read" : "", + "crm.objects.emails.write" : "", + "crm.objects.feedback_submissions.read" : "", + "crm.objects.forecasts.read" : "", + "crm.objects.goals.read" : "", + "crm.objects.goals.write" : "", + "crm.objects.invoices.read" : "", + "crm.objects.invoices.write" : "", + "crm.objects.leads.read" : "", + "crm.objects.leads.write" : "", + "crm.objects.line_items.read" : "", + "crm.objects.line_items.write" : "", + "crm.objects.listings.read" : "", + "crm.objects.listings.write" : "", + "crm.objects.meetings.read" : "", + "crm.objects.meetings.write" : "", + "crm.objects.notes.read" : "", + "crm.objects.notes.write" : "", + "crm.objects.orders.read" : "", + "crm.objects.orders.write" : "", + "crm.objects.partner-clients.read" : "", + "crm.objects.partner-clients.write" : "", + "crm.objects.partner-services.read" : "", + "crm.objects.partner-services.write" : "", + "crm.objects.products.read" : "", + "crm.objects.products.write" : "", + "crm.objects.projects.highly_sensitive.read" : "", + "crm.objects.projects.highly_sensitive.write" : "", + "crm.objects.projects.read" : "", + "crm.objects.projects.sensitive.read" : "", + "crm.objects.projects.sensitive.write" : "", + "crm.objects.projects.write" : "", + "crm.objects.quotes.read" : "", + "crm.objects.quotes.write" : "", + "crm.objects.services.read" : "", + "crm.objects.services.write" : "", + "crm.objects.subscriptions.read" : "", + "crm.objects.subscriptions.write" : "", + "crm.objects.tasks.read" : "", + "crm.objects.tasks.write" : "", + "crm.objects.tickets.highly_sensitive.read" : "", + "crm.objects.tickets.highly_sensitive.write" : "", + "crm.objects.tickets.read" : "", + "crm.objects.tickets.sensitive.read" : "", + "crm.objects.tickets.sensitive.write" : "", + "crm.objects.tickets.write" : "", + "crm.objects.users.read" : "", + "crm.objects.users.write" : "", + "e-commerce" : "", + "media_bridge.read" : "", + "oauth" : "", + "revenue.contracts.read" : "", + "tickets.highly_sensitive.v2" : "", + "tickets.sensitive.v2" : "" + } + } + }, + "x-hubspot-app-availability" : { + "cpq.price_books.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.appointments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.commercepayments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.commercepayments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.companies.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.contacts.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contracts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.custom.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.feedback_submissions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.forecasts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-clients.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-clients.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.products.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.products.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "e-commerce" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "media_bridge.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "oauth" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "revenue.contracts.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "tickets.highly_sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "tickets.sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + } + } + } + } + }, + "x-hubspot-available-client-libraries" : [ "Node", "Python", "Ruby", "PHP" ], + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + } +} \ No newline at end of file diff --git a/spec/hubspot/leads.json b/spec/hubspot/leads.json new file mode 100644 index 0000000..8e76fd3 --- /dev/null +++ b/spec/hubspot/leads.json @@ -0,0 +1,3106 @@ +{ + "openapi" : "3.0.1", + "info" : { + "title" : "Leads", + "description" : "Basepom for all HubSpot Projects", + "version" : "2026-03", + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "PROFESSIONAL", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + }, + "x-hubspot-api-use-case" : "When an existing contact shows an interest in purchasing a product or service, create a lead record to track the sales prospecting journey.", + "x-hubspot-introduction" : "In HubSpot, leads are contacts or companies that are potential customers who have shown interest in your products or services. Use the leads API to create and manage lead records in your HubSpot account, as well as sync lead data between HubSpot and other systems." + }, + "servers" : [ { + "url" : "https://api.hubapi.com" + } ], + "tags" : [ { + "name" : "Basic" + }, { + "name" : "Batch" + }, { + "name" : "Search" + } ], + "paths" : { + "/crm/objects/2026-03/leads" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "List", + "description" : "Read a page of leads. Control what is returned via the `properties` query param.", + "operationId" : "get-/crm/objects/2026-03/leads_getPage", + "parameters" : [ { + "name" : "after", + "in" : "query", + "description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "associations", + "in" : "query", + "description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum number of results to display per page.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 10 + } + }, { + "name" : "properties", + "in" : "query", + "description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "propertiesWithHistory", + "in" : "query", + "description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponseSimplePublicObjectWithAssociationsForwardPaging" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "post" : { + "tags" : [ "Basic" ], + "summary" : "Create", + "description" : "Create a lead with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard leads is provided.", + "operationId" : "post-/crm/objects/2026-03/leads_create", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectInputForCreate" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "headers" : { + "Location" : { + "description" : "URL of the newly created resource", + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/leads/batch/archive" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Archive a batch of leads by ID", + "description" : "Archive multiple leads by their IDs in a single request, moving them to the recycling bin.", + "operationId" : "post-/crm/objects/2026-03/leads/batch/archive_archive", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectId" + } + } + }, + "required" : true + }, + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/leads/batch/create" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Create a batch of leads", + "description" : "Create multiple lead records in a single request by providing a batch of lead data. This endpoint allows for efficient creation of leads by processing them together, which can be useful for syncing data from other systems or importing large datasets.", + "operationId" : "post-/crm/objects/2026-03/leads/batch/create_create", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputForCreate" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/leads/batch/read" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Read a batch of leads by internal ID, or unique property values", + "description" : "Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ", + "operationId" : "post-/crm/objects/2026-03/leads/batch/read_read", + "parameters" : [ { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchReadInputSimplePublicObjectId" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/leads/batch/update" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Update a batch of leads by internal ID, or unique property values", + "description" : "Update multiple lead records using their internal IDs or unique property values. This endpoint allows batch processing of updates, where each lead's properties can be modified based on the provided input. Ensure that the properties being updated exist on the lead objects to avoid errors.", + "operationId" : "post-/crm/objects/2026-03/leads/batch/update_update", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/leads/batch/upsert" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Create or update a batch of leads by unique property values", + "description" : "Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.", + "operationId" : "post-/crm/objects/2026-03/leads/batch/upsert_upsert", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputUpsert" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicUpsertObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicUpsertObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/leads/search" : { + "post" : { + "tags" : [ "Search" ], + "summary" : "Search for leads using specified criteria.", + "description" : "Perform a search for leads based on the provided filter groups, properties, and sorting options. The request allows for pagination and can return up to 200 results per page.", + "operationId" : "post-/crm/objects/2026-03/leads/search_doSearch", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PublicObjectSearchRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponseWithTotalSimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/leads/{leadsId}" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Read", + "description" : "Read an Object identified by `{leadsId}`. `{leadsId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.", + "operationId" : "get-/crm/objects/2026-03/leads/{leadsId}_getById", + "parameters" : [ { + "name" : "leadsId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + }, { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "associations", + "in" : "query", + "description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "idProperty", + "in" : "query", + "description" : "The name of a property whose values are unique for this object type", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "properties", + "in" : "query", + "description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "propertiesWithHistory", + "in" : "query", + "description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "delete" : { + "tags" : [ "Basic" ], + "summary" : "Archive", + "description" : "Move an Object identified by `{leadsId}` to the recycling bin.", + "operationId" : "delete-/crm/objects/2026-03/leads/{leadsId}_archive", + "parameters" : [ { + "name" : "leadsId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "patch" : { + "tags" : [ "Basic" ], + "summary" : "Update", + "description" : "Perform a partial update of an Object identified by `{leadsId}`or optionally a unique property value as specified by the `idProperty` query param. `{leadsId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + "operationId" : "patch-/crm/objects/2026-03/leads/{leadsId}_update", + "parameters" : [ { + "name" : "leadsId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + }, { + "name" : "idProperty", + "in" : "query", + "description" : "The name of a property whose values are unique for this object type", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}" : { + "put" : { + "tags" : [ "Batch" ], + "operationId" : "put-/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "fromObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "fromObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponsePublicDefaultAssociation" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}" : { + "put" : { + "tags" : [ "Basic" ], + "operationId" : "put-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "objectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AssociationSpec" + } + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "headers" : { + "Location" : { + "description" : "URL of the newly created resource", + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LabelsBetweenObjectPair" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "delete" : { + "tags" : [ "Basic" ], + "operationId" : "delete-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "objectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : true + } + } + } + }, + "components" : { + "schemas" : { + "AssociatedId" : { + "required" : [ "id", "type" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique identifier for the associated object." + }, + "type" : { + "type" : "string", + "description" : "The type of associations.", + "example" : "deal_to_contact" + } + }, + "description" : "Contains the id and type of an association" + }, + "AssociationSpec" : { + "required" : [ "associationCategory", "associationTypeId" ], + "type" : "object", + "properties" : { + "associationCategory" : { + "type" : "string", + "description" : "The category of the association, indicating its origin or purpose. Valid values include \"HUBSPOT_DEFINED\", \"USER_DEFINED\", \"INTEGRATOR_DEFINED\", and \"WORK\".", + "enum" : [ "HUBSPOT_DEFINED", "INTEGRATOR_DEFINED", "USER_DEFINED", "WORK" ] + }, + "associationTypeId" : { + "type" : "integer", + "description" : "An integer representing the unique identifier for the type of association.", + "format" : "int32" + } + }, + "description" : "Defines the type, direction, and details of the relationship between two CRM objects." + }, + "BatchInputSimplePublicObjectBatchInput" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be processed in the batch operation. Each object in the array contains the data necessary for the specific operation being performed.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInput" + } + } + }, + "description" : "Represents a batch input component used to handle multiple simple public objects in a single API request. This component is typically used when performing batch operations to create, update, or delete multiple records simultaneously." + }, + "BatchInputSimplePublicObjectBatchInputForCreate" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be created. Each object in the array contains the necessary data for creating a new entry in the system.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInputForCreate" + } + } + }, + "description" : "Represents a batch input for creating multiple simple public objects in a single request. This component is used to streamline the process of adding new objects to a HubSpot account by allowing multiple entries to be created at once." + }, + "BatchInputSimplePublicObjectBatchInputUpsert" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be upserted. Each object in the array contains the necessary data for creating or updating a record in HubSpot.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInputUpsert" + } + } + }, + "description" : "Represents a batch input operation for upserting simple public objects in HubSpot. This component is used to process multiple upsert operations in a single request, improving efficiency and performance." + }, + "BatchInputSimplePublicObjectId" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public object IDs to be processed in the batch operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectId" + } + } + }, + "description" : "Represents a batch input payload containing a list of simple public object IDs. This component is used when performing batch operations on multiple objects within HubSpot." + }, + "BatchReadInputSimplePublicObjectId" : { + "required" : [ "inputs", "properties", "propertiesWithHistory" ], + "type" : "object", + "properties" : { + "idProperty" : { + "type" : "string", + "description" : "When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID." + }, + "inputs" : { + "type" : "array", + "description" : "An array of SimplePublicObjectId objects, each containing the ID of an object to be read.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectId" + } + }, + "properties" : { + "type" : "array", + "description" : "An array of the property names to be returned in the response. If a specified property is not present on the requested object(s), it will be ignored.", + "items" : { + "type" : "string" + } + }, + "propertiesWithHistory" : { + "type" : "array", + "description" : "An array of the property names to be returned along with their history of previous values. If a specified property is not present on the requested object(s), it will be ignored.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property." + }, + "BatchResponsePublicDefaultAssociation" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "description" : "An array of StandardError objects detailing any errors that occurred during the batch operation.", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "numErrors" : { + "type" : "integer", + "description" : "The total number of errors that occurred during the operation.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of PublicDefaultAssociation objects representing the results of the batch operation.", + "items" : { + "$ref" : "#/components/schemas/PublicDefaultAssociation" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "The response returned after performing a batch operation on associations." + }, + "BatchResponseSimplePublicObject" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch request was initially made, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of SimplePublicObject items representing the results of the batch operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing began, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request: \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\"", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "A public object batch response object" + }, + "BatchResponseSimplePublicObjectWithErrors" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "numErrors" : { + "type" : "integer", + "description" : "The number of errors encountered during the batch process.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request - \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\"", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the result of a batch operation on CRM objects, including the processing status, batch results, timestamps, and a list of any errors encountered during the operation." + }, + "BatchResponseSimplePublicUpsertObject" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of SimplePublicUpsertObject items representing the results of the batch upsert operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicUpsertObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects." + }, + "BatchResponseSimplePublicUpsertObjectWithErrors" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "numErrors" : { + "type" : "integer", + "description" : "The number of errors encountered during the batch process.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SimplePublicUpsertObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the response from a batch upsert operation, including the status, timestamps, successfully processed objects, and any errors that occurred during processing." + }, + "CollectionResponseAssociatedId" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/Paging" + }, + "results" : { + "type" : "array", + "description" : "A list of associated IDs retrieved from the API request.", + "items" : { + "$ref" : "#/components/schemas/AssociatedId" + } + } + }, + "description" : "Represents a collection of associated IDs returned by an API request, including pagination details for navigating through the results." + }, + "CollectionResponseSimplePublicObjectWithAssociationsForwardPaging" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/ForwardPaging" + }, + "results" : { + "type" : "array", + "description" : "An array of simple public objects that are included in the current page of the response. Each object may include its associated data.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations" + } + } + }, + "description" : "Represents a paginated collection response that includes simple public objects with their associations. This component is used to handle the results and pagination details when retrieving a list of objects from the API." + }, + "CollectionResponseWithTotalSimplePublicObject" : { + "required" : [ "results", "total" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/Paging" + }, + "results" : { + "type" : "array", + "description" : "An array containing the simple public objects returned in the current page of the response. This property is required.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "total" : { + "type" : "integer", + "description" : "The number of available results", + "format" : "int32" + } + }, + "description" : "Represents a list of simple objects returned from an API request, along with the total count of objects available." + }, + "Error" : { + "required" : [ "category", "correlationId", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The error category" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}" + }, + "correlationId" : { + "type" : "string", + "description" : "A unique identifier for the request. Include this value with any error reports or support tickets", + "format" : "uuid", + "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf" + }, + "errors" : { + "type" : "array", + "description" : "further information about the error", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps" + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate", + "example" : "An error occurred" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered.", + "example" : { + "message" : "Invalid input (details will vary based on the error)", + "correlationId" : "aeb5f871-7f07-4993-9211-075dc63e7cbf", + "category" : "VALIDATION_ERROR", + "links" : { + "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base" + } + } + }, + "ErrorDetail" : { + "required" : [ "message" ], + "type" : "object", + "properties" : { + "code" : { + "type" : "string", + "description" : "The status code associated with the error detail" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{missingScopes=[scope1, scope2]}" + }, + "in" : { + "type" : "string", + "description" : "The name of the field or parameter in which the error was found." + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response." + }, + "Filter" : { + "required" : [ "operator", "propertyName" ], + "type" : "object", + "properties" : { + "highValue" : { + "type" : "string", + "description" : "The upper boundary value when using ranged-based filters." + }, + "operator" : { + "type" : "string", + "description" : "The comparison operator used in the filter, such as \"EQ\" or \"GT\".", + "enum" : [ "BETWEEN", "CONTAINS_TOKEN", "EQ", "GT", "GTE", "HAS_PROPERTY", "IN", "LT", "LTE", "NEQ", "NOT_CONTAINS_TOKEN", "NOT_HAS_PROPERTY", "NOT_IN" ] + }, + "propertyName" : { + "type" : "string", + "description" : "The name of the property to apply the filter to." + }, + "value" : { + "type" : "string", + "description" : "The value to match against the property." + }, + "values" : { + "type" : "array", + "description" : "The values to match against the property.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against. " + }, + "FilterGroup" : { + "required" : [ "filters" ], + "type" : "object", + "properties" : { + "filters" : { + "type" : "array", + "description" : "A list of individual filter criteria that are applied together as a group. Each filter specifies a condition that records must meet to be included in the results.", + "items" : { + "$ref" : "#/components/schemas/Filter" + } + } + }, + "description" : "Represents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints." + }, + "ForwardPaging" : { + "type" : "object", + "properties" : { + "next" : { + "$ref" : "#/components/schemas/NextPage" + } + }, + "description" : "Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page." + }, + "LabelsBetweenObjectPair" : { + "required" : [ "fromObjectId", "fromObjectTypeId", "labels", "toObjectId", "toObjectTypeId" ], + "type" : "object", + "properties" : { + "fromObjectId" : { + "type" : "string", + "description" : "Source unique ID of the object." + }, + "fromObjectTypeId" : { + "type" : "string", + "description" : "Source object type." + }, + "labels" : { + "type" : "array", + "description" : "An array of labels that describe the relationship between the two objects. This is a required property.", + "items" : { + "type" : "string" + } + }, + "toObjectId" : { + "type" : "string", + "description" : "Target unique ID of the object." + }, + "toObjectTypeId" : { + "type" : "string", + "description" : "Target object type." + } + }, + "description" : "The relationship descriptors applicable between two object types." + }, + "NextPage" : { + "required" : [ "after" ], + "type" : "object", + "properties" : { + "after" : { + "type" : "string", + "description" : "A paging cursor token for retrieving subsequent pages." + }, + "link" : { + "type" : "string", + "description" : "A URL that can be used to retrieve the next page results." + } + }, + "description" : "Specifies the paging information needed to retrieve the next set of results in a paginated API response" + }, + "Paging" : { + "type" : "object", + "properties" : { + "next" : { + "$ref" : "#/components/schemas/NextPage" + }, + "prev" : { + "$ref" : "#/components/schemas/PreviousPage" + } + }, + "description" : "Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results." + }, + "PreviousPage" : { + "required" : [ "before" ], + "type" : "object", + "properties" : { + "before" : { + "type" : "string", + "description" : "A paging cursor token for retrieving previous pages." + }, + "link" : { + "type" : "string", + "description" : "A URL that can be used to retrieve the previous pages' results." + } + }, + "description" : "specifies the paging information needed to retrieve the previous set of results in a paginated API response" + }, + "PublicAssociationsForObject" : { + "required" : [ "to", "types" ], + "type" : "object", + "properties" : { + "to" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "types" : { + "type" : "array", + "description" : "The types of associations that exist between the object and other entities, indicating the nature of their relationship.", + "items" : { + "$ref" : "#/components/schemas/AssociationSpec" + } + } + }, + "description" : "Represents the associations for a specific object in HubSpot, detailing the types of associations and the related objects involved." + }, + "PublicDefaultAssociation" : { + "required" : [ "associationSpec", "from", "to" ], + "type" : "object", + "properties" : { + "associationSpec" : { + "$ref" : "#/components/schemas/AssociationSpec" + }, + "from" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "to" : { + "$ref" : "#/components/schemas/PublicObjectId" + } + }, + "description" : "The PublicDefaultAssociation component represents the default association configuration between two objects in HubSpot. It is used to define how objects are related to each other within the platform." + }, + "PublicObjectId" : { + "required" : [ "id" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + } + }, + "description" : "Contains the Id of a Public Object" + }, + "PublicObjectSearchRequest" : { + "required" : [ "after", "filterGroups", "limit", "properties", "sorts" ], + "type" : "object", + "properties" : { + "after" : { + "type" : "string", + "description" : "A paging cursor token for retrieving subsequent pages." + }, + "filterGroups" : { + "type" : "array", + "description" : "Up to 6 groups of filters defining additional query criteria.", + "items" : { + "$ref" : "#/components/schemas/FilterGroup" + } + }, + "limit" : { + "type" : "integer", + "description" : "The maximum results to return, up to 200 objects.", + "format" : "int32" + }, + "properties" : { + "type" : "array", + "description" : "A list of property names to include in the response.", + "items" : { + "type" : "string" + } + }, + "query" : { + "type" : "string", + "description" : "The search query string, up to 3000 characters." + }, + "sorts" : { + "type" : "array", + "description" : "Specifies sorting order based on object properties.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Describes a search request" + }, + "PublicObjectWarning" : { + "required" : [ "category", "context", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The classification of the warning, indicating the type or nature of the issue." + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Additional information or metadata about the warning, providing context for understanding the issue." + }, + "message" : { + "type" : "string", + "description" : "The text of the warning message, providing information about the issue or alert." + } + }, + "description" : "Represents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning." + }, + "SimplePublicObject" : { + "required" : [ "archived", "createdAt", "id", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used to trace the write request for the object. Set a unique ID for each write operation; it is returned with any errors so you can identify which request encountered which error." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history, each with a timestamp and source information." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL associated with the object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "A simple public object." + }, + "SimplePublicObjectBatchInput" : { + "required" : [ "id", "properties" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id to be updated. This can be the object id, or the unique property value of the idProperty property" + }, + "idProperty" : { + "type" : "string", + "description" : "The name of a property whose values are unique for this object", + "example" : "my_unique_property_name" + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "A unique identifier for tracing the request." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs representing the properties of the object." + } + }, + "description" : "Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties." + }, + "SimplePublicObjectBatchInputForCreate" : { + "required" : [ "associations", "properties" ], + "type" : "object", + "properties" : { + "associations" : { + "type" : "array", + "description" : "An array of associations that define the relationships between the objects being created and other existing objects. This property is required.", + "items" : { + "$ref" : "#/components/schemas/PublicAssociationsForObject" + } + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the creation or update request of the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "An input object that contains a collection of objects to be created together in a batch." + }, + "SimplePublicObjectBatchInputUpsert" : { + "required" : [ "id", "properties" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "idProperty" : { + "type" : "string", + "description" : "The name of a property whose values are unique for this object" + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier for tracing the creation request." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID." + }, + "SimplePublicObjectId" : { + "required" : [ "id" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object.", + "example" : "430001" + } + }, + "description" : "Contains the Id of a Public Object" + }, + "SimplePublicObjectInput" : { + "required" : [ "properties" ], + "type" : "object", + "properties" : { + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "Represents the input required to update a CRM object, containing an object with property names and their corresponding values." + }, + "SimplePublicObjectInputForCreate" : { + "required" : [ "associations", "properties" ], + "type" : "object", + "properties" : { + "associations" : { + "type" : "array", + "description" : "An array that specifies the relationships between the new public object and existing objects. This is required to establish how the new object is connected within the system.", + "items" : { + "$ref" : "#/components/schemas/PublicAssociationsForObject" + } + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs for setting properties for the new object." + } + }, + "description" : "Is the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects." + }, + "SimplePublicObjectWithAssociations" : { + "required" : [ "archived", "createdAt", "id", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "associations" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/CollectionResponseAssociatedId" + }, + "description" : "A map of associated object types to their associated IDs." + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the creation or update request of the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL link to access this object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type." + }, + "SimplePublicUpsertObject" : { + "required" : [ "archived", "createdAt", "id", "new", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "new" : { + "type" : "boolean", + "description" : "Whether the property is new." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the write request for the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL associated with the object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "Represents a CRM object that has either been created or updated (upserted)" + }, + "StandardError" : { + "required" : [ "category", "context", "errors", "links", "message", "status" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The main category of the error." + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Additional context-specific information related to the error." + }, + "errors" : { + "type" : "array", + "description" : "The detailed error objects.", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "id" : { + "type" : "string", + "description" : "A unique ID for the error instance." + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "URLs linking to documentation or resources associated with the error." + }, + "message" : { + "type" : "string", + "description" : "A human-readable string describing the error and possible remediation steps." + }, + "status" : { + "type" : "string", + "description" : "A text status code for the error, typically \"error\"." + }, + "subCategory" : { + "type" : "object", + "properties" : { }, + "description" : "A more specific error category within each main category." + } + }, + "description" : "Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request." + }, + "ValueWithTimestamp" : { + "required" : [ "sourceType", "timestamp", "value" ], + "type" : "object", + "properties" : { + "sourceId" : { + "type" : "string", + "description" : "A string identifier for the specific source of the value." + }, + "sourceLabel" : { + "type" : "string", + "description" : "A human-readable label." + }, + "sourceType" : { + "type" : "string", + "description" : "A string indicating the type of source from which the value originated." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp when the property was updated, in ISO 8601 format.", + "format" : "date-time" + }, + "updatedByUserId" : { + "type" : "integer", + "description" : "The ID of the user who last updated the property.", + "format" : "int32" + }, + "value" : { + "type" : "string", + "description" : "The property value." + } + }, + "description" : "Property model that includes timestamp." + } + }, + "responses" : { + "Error" : { + "description" : "An error occurred.", + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + } + } + } + }, + "securitySchemes" : { + "developer_hapikey" : { + "type" : "apiKey", + "name" : "hapikey", + "in" : "query" + }, + "oauth2" : { + "type" : "oauth2", + "flows" : { + "authorizationCode" : { + "authorizationUrl" : "https://app.hubspot.com/oauth/authorize", + "tokenUrl" : "https://api.hubapi.com/oauth/v1/token", + "scopes" : { + "cpq.price_books.read" : "", + "crm.objects.appointments.read" : "", + "crm.objects.appointments.sensitive.read.v2" : "", + "crm.objects.appointments.sensitive.write.v2" : "", + "crm.objects.appointments.write" : "", + "crm.objects.calls.read" : "", + "crm.objects.calls.write" : "", + "crm.objects.carts.read" : "", + "crm.objects.carts.write" : "", + "crm.objects.commercepayments.read" : "", + "crm.objects.commercepayments.write" : "", + "crm.objects.companies.highly_sensitive.read.v2" : "", + "crm.objects.companies.highly_sensitive.write.v2" : "", + "crm.objects.companies.read" : "", + "crm.objects.companies.sensitive.read.v2" : "", + "crm.objects.companies.sensitive.write.v2" : "", + "crm.objects.companies.write" : "", + "crm.objects.contacts.highly_sensitive.read.v2" : "", + "crm.objects.contacts.highly_sensitive.write.v2" : "", + "crm.objects.contacts.read" : "", + "crm.objects.contacts.sensitive.read.v2" : "", + "crm.objects.contacts.sensitive.write.v2" : "", + "crm.objects.contacts.write" : "", + "crm.objects.contracts.read" : "", + "crm.objects.courses.read" : "", + "crm.objects.courses.write" : "", + "crm.objects.custom.highly_sensitive.read.v2" : "", + "crm.objects.custom.highly_sensitive.write.v2" : "", + "crm.objects.custom.read" : "", + "crm.objects.custom.sensitive.read.v2" : "", + "crm.objects.custom.sensitive.write.v2" : "", + "crm.objects.custom.write" : "", + "crm.objects.deals.highly_sensitive.read.v2" : "", + "crm.objects.deals.highly_sensitive.write.v2" : "", + "crm.objects.deals.read" : "", + "crm.objects.deals.sensitive.read.v2" : "", + "crm.objects.deals.sensitive.write.v2" : "", + "crm.objects.deals.write" : "", + "crm.objects.emails.read" : "", + "crm.objects.emails.write" : "", + "crm.objects.feedback_submissions.read" : "", + "crm.objects.forecasts.read" : "", + "crm.objects.goals.read" : "", + "crm.objects.goals.write" : "", + "crm.objects.invoices.read" : "", + "crm.objects.invoices.write" : "", + "crm.objects.leads.read" : "", + "crm.objects.leads.write" : "", + "crm.objects.line_items.read" : "", + "crm.objects.line_items.write" : "", + "crm.objects.listings.read" : "", + "crm.objects.listings.write" : "", + "crm.objects.meetings.read" : "", + "crm.objects.meetings.write" : "", + "crm.objects.notes.read" : "", + "crm.objects.notes.write" : "", + "crm.objects.orders.read" : "", + "crm.objects.orders.write" : "", + "crm.objects.partner-clients.read" : "", + "crm.objects.partner-clients.write" : "", + "crm.objects.partner-services.read" : "", + "crm.objects.partner-services.write" : "", + "crm.objects.products.read" : "", + "crm.objects.products.write" : "", + "crm.objects.projects.highly_sensitive.read" : "", + "crm.objects.projects.highly_sensitive.write" : "", + "crm.objects.projects.read" : "", + "crm.objects.projects.sensitive.read" : "", + "crm.objects.projects.sensitive.write" : "", + "crm.objects.projects.write" : "", + "crm.objects.quotes.read" : "", + "crm.objects.quotes.write" : "", + "crm.objects.services.read" : "", + "crm.objects.services.write" : "", + "crm.objects.subscriptions.read" : "", + "crm.objects.subscriptions.write" : "", + "crm.objects.tasks.read" : "", + "crm.objects.tasks.write" : "", + "crm.objects.tickets.highly_sensitive.read" : "", + "crm.objects.tickets.highly_sensitive.write" : "", + "crm.objects.tickets.read" : "", + "crm.objects.tickets.sensitive.read" : "", + "crm.objects.tickets.sensitive.write" : "", + "crm.objects.tickets.write" : "", + "crm.objects.users.read" : "", + "crm.objects.users.write" : "", + "e-commerce" : "", + "media_bridge.read" : "", + "oauth" : "", + "revenue.contracts.read" : "", + "tickets.highly_sensitive.v2" : "", + "tickets.sensitive.v2" : "" + } + } + }, + "x-hubspot-app-availability" : { + "cpq.price_books.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.appointments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.commercepayments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.commercepayments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.companies.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.contacts.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contracts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.custom.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.feedback_submissions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.forecasts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-clients.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-clients.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.products.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.products.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "e-commerce" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "media_bridge.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "oauth" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "revenue.contracts.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "tickets.highly_sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "tickets.sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + } + } + } + } + }, + "x-hubspot-available-client-libraries" : [ "PHP" ], + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "PROFESSIONAL", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + } +} \ No newline at end of file diff --git a/spec/hubspot/meetings.json b/spec/hubspot/meetings.json new file mode 100644 index 0000000..5ab7b3d --- /dev/null +++ b/spec/hubspot/meetings.json @@ -0,0 +1,3106 @@ +{ + "openapi" : "3.0.1", + "info" : { + "title" : "Meetings", + "description" : "Basepom for all HubSpot Projects", + "version" : "2026-03", + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + }, + "x-hubspot-api-use-case" : "If you're using a different service outside of HubSpot to schedule your meetings, or if you want to supplement the built-in tracking of the HubSpot meetings tool, you can use this API to help keep track of how your meetings went with prospects and customers in the HubSpot CRM.", + "x-hubspot-introduction" : "The meetings engagements API allows you to log and manage meetings on the corresponding CRM records, such as contacts or companies. You can include notes from the meeting and its outcome, along with other important data from the meeting to share with the rest of your team." + }, + "servers" : [ { + "url" : "https://api.hubapi.com" + } ], + "tags" : [ { + "name" : "Basic" + }, { + "name" : "Batch" + }, { + "name" : "Search" + } ], + "paths" : { + "/crm/objects/2026-03/meetings" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "List", + "description" : "Read a page of meetings. Control what is returned via the `properties` query param.", + "operationId" : "get-/crm/objects/2026-03/meetings_getPage", + "parameters" : [ { + "name" : "after", + "in" : "query", + "description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "associations", + "in" : "query", + "description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum number of results to display per page.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 10 + } + }, { + "name" : "properties", + "in" : "query", + "description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "propertiesWithHistory", + "in" : "query", + "description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponseSimplePublicObjectWithAssociationsForwardPaging" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "post" : { + "tags" : [ "Basic" ], + "summary" : "Create", + "description" : "Create a meeting with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard meetings is provided.", + "operationId" : "post-/crm/objects/2026-03/meetings_create", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectInputForCreate" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "headers" : { + "Location" : { + "description" : "URL of the newly created resource", + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/meetings/batch/archive" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Archive a batch of meetings by ID", + "description" : "Delete a batch of meetings by ID.", + "operationId" : "post-/crm/objects/2026-03/meetings/batch/archive_archive", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectId" + } + } + }, + "required" : true + }, + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/meetings/batch/create" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Create a batch of meetings", + "description" : "Create a batch of meetings. The `inputs` array can contain a `properties` object to define property values for the record, along with an `associations` array to define relationships with other object records.", + "operationId" : "post-/crm/objects/2026-03/meetings/batch/create_create", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputForCreate" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/meetings/batch/read" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Read a batch of meetings by internal ID, or unique property values", + "description" : "Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ", + "operationId" : "post-/crm/objects/2026-03/meetings/batch/read_read", + "parameters" : [ { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchReadInputSimplePublicObjectId" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/meetings/batch/update" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Update a batch of meetings by internal ID, or unique property values", + "description" : "Update a batch of meetings by ID (`objectId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + "operationId" : "post-/crm/objects/2026-03/meetings/batch/update_update", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/meetings/batch/upsert" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Create or update a batch of meetings by unique property values", + "description" : "Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.", + "operationId" : "post-/crm/objects/2026-03/meetings/batch/upsert_upsert", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputUpsert" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicUpsertObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicUpsertObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/meetings/search" : { + "post" : { + "tags" : [ "Search" ], + "summary" : "Search for meetings", + "description" : "Search for meetings by filtering on properties, searching through associations, and sorting results.", + "operationId" : "post-/crm/objects/2026-03/meetings/search_doSearch", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PublicObjectSearchRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponseWithTotalSimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/meetings/{meetingId}" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Read", + "description" : "Read an Object identified by `{meetingId}`. `{meetingId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.", + "operationId" : "get-/crm/objects/2026-03/meetings/{meetingId}_getById", + "parameters" : [ { + "name" : "meetingId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + }, { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "associations", + "in" : "query", + "description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "idProperty", + "in" : "query", + "description" : "The name of a property whose values are unique for this object type", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "properties", + "in" : "query", + "description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "propertiesWithHistory", + "in" : "query", + "description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "delete" : { + "tags" : [ "Basic" ], + "summary" : "Archive", + "description" : "Move an Object identified by `{meetingId}` to the recycling bin.", + "operationId" : "delete-/crm/objects/2026-03/meetings/{meetingId}_archive", + "parameters" : [ { + "name" : "meetingId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "patch" : { + "tags" : [ "Basic" ], + "summary" : "Update", + "description" : "Perform a partial update of an Object identified by `{meetingId}`or optionally a unique property value as specified by the `idProperty` query param. `{meetingId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + "operationId" : "patch-/crm/objects/2026-03/meetings/{meetingId}_update", + "parameters" : [ { + "name" : "meetingId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + }, { + "name" : "idProperty", + "in" : "query", + "description" : "The name of a property whose values are unique for this object type", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}" : { + "put" : { + "tags" : [ "Batch" ], + "operationId" : "put-/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "fromObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "fromObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponsePublicDefaultAssociation" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}" : { + "put" : { + "tags" : [ "Basic" ], + "operationId" : "put-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "objectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AssociationSpec" + } + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "headers" : { + "Location" : { + "description" : "URL of the newly created resource", + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LabelsBetweenObjectPair" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "delete" : { + "tags" : [ "Basic" ], + "operationId" : "delete-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "objectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : true + } + } + } + }, + "components" : { + "schemas" : { + "AssociatedId" : { + "required" : [ "id", "type" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique identifier for the associated object." + }, + "type" : { + "type" : "string", + "description" : "The type of associations.", + "example" : "deal_to_contact" + } + }, + "description" : "Contains the id and type of an association" + }, + "AssociationSpec" : { + "required" : [ "associationCategory", "associationTypeId" ], + "type" : "object", + "properties" : { + "associationCategory" : { + "type" : "string", + "description" : "The category of the association, indicating its origin or purpose. Valid values include \"HUBSPOT_DEFINED\", \"USER_DEFINED\", \"INTEGRATOR_DEFINED\", and \"WORK\".", + "enum" : [ "HUBSPOT_DEFINED", "INTEGRATOR_DEFINED", "USER_DEFINED", "WORK" ] + }, + "associationTypeId" : { + "type" : "integer", + "description" : "An integer representing the unique identifier for the type of association.", + "format" : "int32" + } + }, + "description" : "Defines the type, direction, and details of the relationship between two CRM objects." + }, + "BatchInputSimplePublicObjectBatchInput" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be processed in the batch operation. Each object in the array contains the data necessary for the specific operation being performed.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInput" + } + } + }, + "description" : "Represents a batch input component used to handle multiple simple public objects in a single API request. This component is typically used when performing batch operations to create, update, or delete multiple records simultaneously." + }, + "BatchInputSimplePublicObjectBatchInputForCreate" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be created. Each object in the array contains the necessary data for creating a new entry in the system.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInputForCreate" + } + } + }, + "description" : "Represents a batch input for creating multiple simple public objects in a single request. This component is used to streamline the process of adding new objects to a HubSpot account by allowing multiple entries to be created at once." + }, + "BatchInputSimplePublicObjectBatchInputUpsert" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be upserted. Each object in the array contains the necessary data for creating or updating a record in HubSpot.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInputUpsert" + } + } + }, + "description" : "Represents a batch input operation for upserting simple public objects in HubSpot. This component is used to process multiple upsert operations in a single request, improving efficiency and performance." + }, + "BatchInputSimplePublicObjectId" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public object IDs to be processed in the batch operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectId" + } + } + }, + "description" : "Represents a batch input payload containing a list of simple public object IDs. This component is used when performing batch operations on multiple objects within HubSpot." + }, + "BatchReadInputSimplePublicObjectId" : { + "required" : [ "inputs", "properties", "propertiesWithHistory" ], + "type" : "object", + "properties" : { + "idProperty" : { + "type" : "string", + "description" : "When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID." + }, + "inputs" : { + "type" : "array", + "description" : "An array of SimplePublicObjectId objects, each containing the ID of an object to be read.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectId" + } + }, + "properties" : { + "type" : "array", + "description" : "An array of the property names to be returned in the response. If a specified property is not present on the requested object(s), it will be ignored.", + "items" : { + "type" : "string" + } + }, + "propertiesWithHistory" : { + "type" : "array", + "description" : "An array of the property names to be returned along with their history of previous values. If a specified property is not present on the requested object(s), it will be ignored.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property." + }, + "BatchResponsePublicDefaultAssociation" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "description" : "An array of StandardError objects detailing any errors that occurred during the batch operation.", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "numErrors" : { + "type" : "integer", + "description" : "The total number of errors that occurred during the operation.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of PublicDefaultAssociation objects representing the results of the batch operation.", + "items" : { + "$ref" : "#/components/schemas/PublicDefaultAssociation" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "The response returned after performing a batch operation on associations." + }, + "BatchResponseSimplePublicObject" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch request was initially made, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of SimplePublicObject items representing the results of the batch operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing began, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request: \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\"", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "A public object batch response object" + }, + "BatchResponseSimplePublicObjectWithErrors" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "numErrors" : { + "type" : "integer", + "description" : "The number of errors encountered during the batch process.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request - \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\"", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the result of a batch operation on CRM objects, including the processing status, batch results, timestamps, and a list of any errors encountered during the operation." + }, + "BatchResponseSimplePublicUpsertObject" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of SimplePublicUpsertObject items representing the results of the batch upsert operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicUpsertObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects." + }, + "BatchResponseSimplePublicUpsertObjectWithErrors" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "numErrors" : { + "type" : "integer", + "description" : "The number of errors encountered during the batch process.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SimplePublicUpsertObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the response from a batch upsert operation, including the status, timestamps, successfully processed objects, and any errors that occurred during processing." + }, + "CollectionResponseAssociatedId" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/Paging" + }, + "results" : { + "type" : "array", + "description" : "A list of associated IDs retrieved from the API request.", + "items" : { + "$ref" : "#/components/schemas/AssociatedId" + } + } + }, + "description" : "Represents a collection of associated IDs returned by an API request, including pagination details for navigating through the results." + }, + "CollectionResponseSimplePublicObjectWithAssociationsForwardPaging" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/ForwardPaging" + }, + "results" : { + "type" : "array", + "description" : "An array of simple public objects that are included in the current page of the response. Each object may include its associated data.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations" + } + } + }, + "description" : "Represents a paginated collection response that includes simple public objects with their associations. This component is used to handle the results and pagination details when retrieving a list of objects from the API." + }, + "CollectionResponseWithTotalSimplePublicObject" : { + "required" : [ "results", "total" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/Paging" + }, + "results" : { + "type" : "array", + "description" : "An array containing the simple public objects returned in the current page of the response. This property is required.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "total" : { + "type" : "integer", + "description" : "The number of available results", + "format" : "int32" + } + }, + "description" : "Represents a list of simple objects returned from an API request, along with the total count of objects available." + }, + "Error" : { + "required" : [ "category", "correlationId", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The error category" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}" + }, + "correlationId" : { + "type" : "string", + "description" : "A unique identifier for the request. Include this value with any error reports or support tickets", + "format" : "uuid", + "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf" + }, + "errors" : { + "type" : "array", + "description" : "further information about the error", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps" + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate", + "example" : "An error occurred" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered.", + "example" : { + "message" : "Invalid input (details will vary based on the error)", + "correlationId" : "aeb5f871-7f07-4993-9211-075dc63e7cbf", + "category" : "VALIDATION_ERROR", + "links" : { + "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base" + } + } + }, + "ErrorDetail" : { + "required" : [ "message" ], + "type" : "object", + "properties" : { + "code" : { + "type" : "string", + "description" : "The status code associated with the error detail" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{missingScopes=[scope1, scope2]}" + }, + "in" : { + "type" : "string", + "description" : "The name of the field or parameter in which the error was found." + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response." + }, + "Filter" : { + "required" : [ "operator", "propertyName" ], + "type" : "object", + "properties" : { + "highValue" : { + "type" : "string", + "description" : "The upper boundary value when using ranged-based filters." + }, + "operator" : { + "type" : "string", + "description" : "The comparison operator used in the filter, such as \"EQ\" or \"GT\".", + "enum" : [ "BETWEEN", "CONTAINS_TOKEN", "EQ", "GT", "GTE", "HAS_PROPERTY", "IN", "LT", "LTE", "NEQ", "NOT_CONTAINS_TOKEN", "NOT_HAS_PROPERTY", "NOT_IN" ] + }, + "propertyName" : { + "type" : "string", + "description" : "The name of the property to apply the filter to." + }, + "value" : { + "type" : "string", + "description" : "The value to match against the property." + }, + "values" : { + "type" : "array", + "description" : "The values to match against the property.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against. " + }, + "FilterGroup" : { + "required" : [ "filters" ], + "type" : "object", + "properties" : { + "filters" : { + "type" : "array", + "description" : "A list of individual filter criteria that are applied together as a group. Each filter specifies a condition that records must meet to be included in the results.", + "items" : { + "$ref" : "#/components/schemas/Filter" + } + } + }, + "description" : "Represents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints." + }, + "ForwardPaging" : { + "type" : "object", + "properties" : { + "next" : { + "$ref" : "#/components/schemas/NextPage" + } + }, + "description" : "Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page." + }, + "LabelsBetweenObjectPair" : { + "required" : [ "fromObjectId", "fromObjectTypeId", "labels", "toObjectId", "toObjectTypeId" ], + "type" : "object", + "properties" : { + "fromObjectId" : { + "type" : "string", + "description" : "Source unique ID of the object." + }, + "fromObjectTypeId" : { + "type" : "string", + "description" : "Source object type." + }, + "labels" : { + "type" : "array", + "description" : "An array of labels that describe the relationship between the two objects. This is a required property.", + "items" : { + "type" : "string" + } + }, + "toObjectId" : { + "type" : "string", + "description" : "Target unique ID of the object." + }, + "toObjectTypeId" : { + "type" : "string", + "description" : "Target object type." + } + }, + "description" : "The relationship descriptors applicable between two object types." + }, + "NextPage" : { + "required" : [ "after" ], + "type" : "object", + "properties" : { + "after" : { + "type" : "string", + "description" : "A paging cursor token for retrieving subsequent pages." + }, + "link" : { + "type" : "string", + "description" : "A URL that can be used to retrieve the next page results." + } + }, + "description" : "Specifies the paging information needed to retrieve the next set of results in a paginated API response" + }, + "Paging" : { + "type" : "object", + "properties" : { + "next" : { + "$ref" : "#/components/schemas/NextPage" + }, + "prev" : { + "$ref" : "#/components/schemas/PreviousPage" + } + }, + "description" : "Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results." + }, + "PreviousPage" : { + "required" : [ "before" ], + "type" : "object", + "properties" : { + "before" : { + "type" : "string", + "description" : "A paging cursor token for retrieving previous pages." + }, + "link" : { + "type" : "string", + "description" : "A URL that can be used to retrieve the previous pages' results." + } + }, + "description" : "specifies the paging information needed to retrieve the previous set of results in a paginated API response" + }, + "PublicAssociationsForObject" : { + "required" : [ "to", "types" ], + "type" : "object", + "properties" : { + "to" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "types" : { + "type" : "array", + "description" : "The types of associations that exist between the object and other entities, indicating the nature of their relationship.", + "items" : { + "$ref" : "#/components/schemas/AssociationSpec" + } + } + }, + "description" : "Represents the associations for a specific object in HubSpot, detailing the types of associations and the related objects involved." + }, + "PublicDefaultAssociation" : { + "required" : [ "associationSpec", "from", "to" ], + "type" : "object", + "properties" : { + "associationSpec" : { + "$ref" : "#/components/schemas/AssociationSpec" + }, + "from" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "to" : { + "$ref" : "#/components/schemas/PublicObjectId" + } + }, + "description" : "The PublicDefaultAssociation component represents the default association configuration between two objects in HubSpot. It is used to define how objects are related to each other within the platform." + }, + "PublicObjectId" : { + "required" : [ "id" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + } + }, + "description" : "Contains the Id of a Public Object" + }, + "PublicObjectSearchRequest" : { + "required" : [ "after", "filterGroups", "limit", "properties", "sorts" ], + "type" : "object", + "properties" : { + "after" : { + "type" : "string", + "description" : "A paging cursor token for retrieving subsequent pages." + }, + "filterGroups" : { + "type" : "array", + "description" : "Up to 6 groups of filters defining additional query criteria.", + "items" : { + "$ref" : "#/components/schemas/FilterGroup" + } + }, + "limit" : { + "type" : "integer", + "description" : "The maximum results to return, up to 200 objects.", + "format" : "int32" + }, + "properties" : { + "type" : "array", + "description" : "A list of property names to include in the response.", + "items" : { + "type" : "string" + } + }, + "query" : { + "type" : "string", + "description" : "The search query string, up to 3000 characters." + }, + "sorts" : { + "type" : "array", + "description" : "Specifies sorting order based on object properties.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Describes a search request" + }, + "PublicObjectWarning" : { + "required" : [ "category", "context", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The classification of the warning, indicating the type or nature of the issue." + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Additional information or metadata about the warning, providing context for understanding the issue." + }, + "message" : { + "type" : "string", + "description" : "The text of the warning message, providing information about the issue or alert." + } + }, + "description" : "Represents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning." + }, + "SimplePublicObject" : { + "required" : [ "archived", "createdAt", "id", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used to trace the write request for the object. Set a unique ID for each write operation; it is returned with any errors so you can identify which request encountered which error." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history, each with a timestamp and source information." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL associated with the object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "A simple public object." + }, + "SimplePublicObjectBatchInput" : { + "required" : [ "id", "properties" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id to be updated. This can be the object id, or the unique property value of the idProperty property" + }, + "idProperty" : { + "type" : "string", + "description" : "The name of a property whose values are unique for this object", + "example" : "my_unique_property_name" + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "A unique identifier for tracing the request." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs representing the properties of the object." + } + }, + "description" : "Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties." + }, + "SimplePublicObjectBatchInputForCreate" : { + "required" : [ "associations", "properties" ], + "type" : "object", + "properties" : { + "associations" : { + "type" : "array", + "description" : "An array of associations that define the relationships between the objects being created and other existing objects. This property is required.", + "items" : { + "$ref" : "#/components/schemas/PublicAssociationsForObject" + } + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the creation or update request of the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "An input object that contains a collection of objects to be created together in a batch." + }, + "SimplePublicObjectBatchInputUpsert" : { + "required" : [ "id", "properties" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "idProperty" : { + "type" : "string", + "description" : "The name of a property whose values are unique for this object" + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier for tracing the creation request." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID." + }, + "SimplePublicObjectId" : { + "required" : [ "id" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object.", + "example" : "430001" + } + }, + "description" : "Contains the Id of a Public Object" + }, + "SimplePublicObjectInput" : { + "required" : [ "properties" ], + "type" : "object", + "properties" : { + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "Represents the input required to update a CRM object, containing an object with property names and their corresponding values." + }, + "SimplePublicObjectInputForCreate" : { + "required" : [ "associations", "properties" ], + "type" : "object", + "properties" : { + "associations" : { + "type" : "array", + "description" : "An array that specifies the relationships between the new public object and existing objects. This is required to establish how the new object is connected within the system.", + "items" : { + "$ref" : "#/components/schemas/PublicAssociationsForObject" + } + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs for setting properties for the new object." + } + }, + "description" : "Is the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects." + }, + "SimplePublicObjectWithAssociations" : { + "required" : [ "archived", "createdAt", "id", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "associations" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/CollectionResponseAssociatedId" + }, + "description" : "A map of associated object types to their associated IDs." + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the creation or update request of the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL link to access this object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type." + }, + "SimplePublicUpsertObject" : { + "required" : [ "archived", "createdAt", "id", "new", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "new" : { + "type" : "boolean", + "description" : "Whether the property is new." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the write request for the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL associated with the object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "Represents a CRM object that has either been created or updated (upserted)" + }, + "StandardError" : { + "required" : [ "category", "context", "errors", "links", "message", "status" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The main category of the error." + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Additional context-specific information related to the error." + }, + "errors" : { + "type" : "array", + "description" : "The detailed error objects.", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "id" : { + "type" : "string", + "description" : "A unique ID for the error instance." + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "URLs linking to documentation or resources associated with the error." + }, + "message" : { + "type" : "string", + "description" : "A human-readable string describing the error and possible remediation steps." + }, + "status" : { + "type" : "string", + "description" : "A text status code for the error, typically \"error\"." + }, + "subCategory" : { + "type" : "object", + "properties" : { }, + "description" : "A more specific error category within each main category." + } + }, + "description" : "Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request." + }, + "ValueWithTimestamp" : { + "required" : [ "sourceType", "timestamp", "value" ], + "type" : "object", + "properties" : { + "sourceId" : { + "type" : "string", + "description" : "A string identifier for the specific source of the value." + }, + "sourceLabel" : { + "type" : "string", + "description" : "A human-readable label." + }, + "sourceType" : { + "type" : "string", + "description" : "A string indicating the type of source from which the value originated." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp when the property was updated, in ISO 8601 format.", + "format" : "date-time" + }, + "updatedByUserId" : { + "type" : "integer", + "description" : "The ID of the user who last updated the property.", + "format" : "int32" + }, + "value" : { + "type" : "string", + "description" : "The property value." + } + }, + "description" : "Property model that includes timestamp." + } + }, + "responses" : { + "Error" : { + "description" : "An error occurred.", + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + } + } + } + }, + "securitySchemes" : { + "developer_hapikey" : { + "type" : "apiKey", + "name" : "hapikey", + "in" : "query" + }, + "oauth2" : { + "type" : "oauth2", + "flows" : { + "authorizationCode" : { + "authorizationUrl" : "https://app.hubspot.com/oauth/authorize", + "tokenUrl" : "https://api.hubapi.com/oauth/v1/token", + "scopes" : { + "cpq.price_books.read" : "", + "crm.objects.appointments.read" : "", + "crm.objects.appointments.sensitive.read.v2" : "", + "crm.objects.appointments.sensitive.write.v2" : "", + "crm.objects.appointments.write" : "", + "crm.objects.calls.read" : "", + "crm.objects.calls.write" : "", + "crm.objects.carts.read" : "", + "crm.objects.carts.write" : "", + "crm.objects.commercepayments.read" : "", + "crm.objects.commercepayments.write" : "", + "crm.objects.companies.highly_sensitive.read.v2" : "", + "crm.objects.companies.highly_sensitive.write.v2" : "", + "crm.objects.companies.read" : "", + "crm.objects.companies.sensitive.read.v2" : "", + "crm.objects.companies.sensitive.write.v2" : "", + "crm.objects.companies.write" : "", + "crm.objects.contacts.highly_sensitive.read.v2" : "", + "crm.objects.contacts.highly_sensitive.write.v2" : "", + "crm.objects.contacts.read" : "", + "crm.objects.contacts.sensitive.read.v2" : "", + "crm.objects.contacts.sensitive.write.v2" : "", + "crm.objects.contacts.write" : "", + "crm.objects.contracts.read" : "", + "crm.objects.courses.read" : "", + "crm.objects.courses.write" : "", + "crm.objects.custom.highly_sensitive.read.v2" : "", + "crm.objects.custom.highly_sensitive.write.v2" : "", + "crm.objects.custom.read" : "", + "crm.objects.custom.sensitive.read.v2" : "", + "crm.objects.custom.sensitive.write.v2" : "", + "crm.objects.custom.write" : "", + "crm.objects.deals.highly_sensitive.read.v2" : "", + "crm.objects.deals.highly_sensitive.write.v2" : "", + "crm.objects.deals.read" : "", + "crm.objects.deals.sensitive.read.v2" : "", + "crm.objects.deals.sensitive.write.v2" : "", + "crm.objects.deals.write" : "", + "crm.objects.emails.read" : "", + "crm.objects.emails.write" : "", + "crm.objects.feedback_submissions.read" : "", + "crm.objects.forecasts.read" : "", + "crm.objects.goals.read" : "", + "crm.objects.goals.write" : "", + "crm.objects.invoices.read" : "", + "crm.objects.invoices.write" : "", + "crm.objects.leads.read" : "", + "crm.objects.leads.write" : "", + "crm.objects.line_items.read" : "", + "crm.objects.line_items.write" : "", + "crm.objects.listings.read" : "", + "crm.objects.listings.write" : "", + "crm.objects.meetings.read" : "", + "crm.objects.meetings.write" : "", + "crm.objects.notes.read" : "", + "crm.objects.notes.write" : "", + "crm.objects.orders.read" : "", + "crm.objects.orders.write" : "", + "crm.objects.partner-clients.read" : "", + "crm.objects.partner-clients.write" : "", + "crm.objects.partner-services.read" : "", + "crm.objects.partner-services.write" : "", + "crm.objects.products.read" : "", + "crm.objects.products.write" : "", + "crm.objects.projects.highly_sensitive.read" : "", + "crm.objects.projects.highly_sensitive.write" : "", + "crm.objects.projects.read" : "", + "crm.objects.projects.sensitive.read" : "", + "crm.objects.projects.sensitive.write" : "", + "crm.objects.projects.write" : "", + "crm.objects.quotes.read" : "", + "crm.objects.quotes.write" : "", + "crm.objects.services.read" : "", + "crm.objects.services.write" : "", + "crm.objects.subscriptions.read" : "", + "crm.objects.subscriptions.write" : "", + "crm.objects.tasks.read" : "", + "crm.objects.tasks.write" : "", + "crm.objects.tickets.highly_sensitive.read" : "", + "crm.objects.tickets.highly_sensitive.write" : "", + "crm.objects.tickets.read" : "", + "crm.objects.tickets.sensitive.read" : "", + "crm.objects.tickets.sensitive.write" : "", + "crm.objects.tickets.write" : "", + "crm.objects.users.read" : "", + "crm.objects.users.write" : "", + "e-commerce" : "", + "media_bridge.read" : "", + "oauth" : "", + "revenue.contracts.read" : "", + "tickets.highly_sensitive.v2" : "", + "tickets.sensitive.v2" : "" + } + } + }, + "x-hubspot-app-availability" : { + "cpq.price_books.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.appointments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.commercepayments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.commercepayments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.companies.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.contacts.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contracts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.custom.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.feedback_submissions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.forecasts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-clients.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-clients.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.products.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.products.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "e-commerce" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "media_bridge.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "oauth" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "revenue.contracts.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "tickets.highly_sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "tickets.sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + } + } + } + } + }, + "x-hubspot-available-client-libraries" : [ "Node", "Python", "Ruby", "PHP" ], + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + } +} \ No newline at end of file diff --git a/spec/hubspot/notes.json b/spec/hubspot/notes.json new file mode 100644 index 0000000..7890603 --- /dev/null +++ b/spec/hubspot/notes.json @@ -0,0 +1,3106 @@ +{ + "openapi" : "3.0.1", + "info" : { + "title" : "Notes", + "description" : "Basepom for all HubSpot Projects", + "version" : "2026-03", + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + }, + "x-hubspot-api-use-case" : "If you had an offline conversation with a customer, you could add a note to their contact record with the important takeaways from your conversation.", + "x-hubspot-introduction" : "Use the notes engagements API to include contextual information or associate an attachment with a CRM record. Other users in your HubSpot account will then be able to review the note and any attachments." + }, + "servers" : [ { + "url" : "https://api.hubapi.com" + } ], + "tags" : [ { + "name" : "Basic" + }, { + "name" : "Batch" + }, { + "name" : "Search" + } ], + "paths" : { + "/crm/objects/2026-03/notes" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "List", + "description" : "Read a page of notes. Control what is returned via the `properties` query param.", + "operationId" : "get-/crm/objects/2026-03/notes_getPage", + "parameters" : [ { + "name" : "after", + "in" : "query", + "description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "associations", + "in" : "query", + "description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum number of results to display per page.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 10 + } + }, { + "name" : "properties", + "in" : "query", + "description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "propertiesWithHistory", + "in" : "query", + "description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponseSimplePublicObjectWithAssociationsForwardPaging" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "post" : { + "tags" : [ "Basic" ], + "summary" : "Create", + "description" : "Create a note with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard notes is provided.", + "operationId" : "post-/crm/objects/2026-03/notes_create", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectInputForCreate" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "headers" : { + "Location" : { + "description" : "URL of the newly created resource", + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/notes/batch/archive" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Archive a batch of notes by ID", + "description" : "Archive multiple notes by their IDs in a single request. This operation moves the specified notes to the recycling bin, making them inaccessible from regular queries.", + "operationId" : "post-/crm/objects/2026-03/notes/batch/archive_archive", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectId" + } + } + }, + "required" : true + }, + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/notes/batch/create" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Create a batch of notes", + "description" : "Create multiple notes in a single request by providing the necessary properties for each note. This operation returns the created notes with their unique identifiers.", + "operationId" : "post-/crm/objects/2026-03/notes/batch/create_create", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputForCreate" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/notes/batch/read" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Read a batch of notes by internal ID, or unique property values", + "description" : "Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ", + "operationId" : "post-/crm/objects/2026-03/notes/batch/read_read", + "parameters" : [ { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchReadInputSimplePublicObjectId" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/notes/batch/update" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Update a batch of notes by internal ID, or unique property values", + "description" : "Update multiple notes using their internal IDs or unique property values. This operation allows you to modify the properties of several notes in a single request, streamlining the process of managing note data in bulk.", + "operationId" : "post-/crm/objects/2026-03/notes/batch/update_update", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/notes/batch/upsert" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Create or update a batch of notes by unique property values", + "description" : "Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.", + "operationId" : "post-/crm/objects/2026-03/notes/batch/upsert_upsert", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputUpsert" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicUpsertObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicUpsertObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/notes/search" : { + "post" : { + "tags" : [ "Search" ], + "summary" : "Search for notes based on specified criteria.", + "description" : "Execute a search for notes using filters, sorting options, and other query parameters to refine the results. This endpoint allows for complex queries to locate specific notes within the CRM system.", + "operationId" : "post-/crm/objects/2026-03/notes/search_doSearch", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PublicObjectSearchRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponseWithTotalSimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/notes/{noteId}" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Read", + "description" : "Read an Object identified by `{noteId}`. `{noteId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.", + "operationId" : "get-/crm/objects/2026-03/notes/{noteId}_getById", + "parameters" : [ { + "name" : "noteId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + }, { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "associations", + "in" : "query", + "description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "idProperty", + "in" : "query", + "description" : "The name of a property whose values are unique for this object type", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "properties", + "in" : "query", + "description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "propertiesWithHistory", + "in" : "query", + "description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "delete" : { + "tags" : [ "Basic" ], + "summary" : "Archive", + "description" : "Move an Object identified by `{noteId}` to the recycling bin.", + "operationId" : "delete-/crm/objects/2026-03/notes/{noteId}_archive", + "parameters" : [ { + "name" : "noteId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "patch" : { + "tags" : [ "Basic" ], + "summary" : "Update", + "description" : "Perform a partial update of an Object identified by `{noteId}`or optionally a unique property value as specified by the `idProperty` query param. `{noteId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + "operationId" : "patch-/crm/objects/2026-03/notes/{noteId}_update", + "parameters" : [ { + "name" : "noteId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + }, { + "name" : "idProperty", + "in" : "query", + "description" : "The name of a property whose values are unique for this object type", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}" : { + "put" : { + "tags" : [ "Batch" ], + "operationId" : "put-/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "fromObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "fromObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponsePublicDefaultAssociation" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}" : { + "put" : { + "tags" : [ "Basic" ], + "operationId" : "put-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "objectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AssociationSpec" + } + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "headers" : { + "Location" : { + "description" : "URL of the newly created resource", + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LabelsBetweenObjectPair" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "delete" : { + "tags" : [ "Basic" ], + "operationId" : "delete-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "objectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : true + } + } + } + }, + "components" : { + "schemas" : { + "AssociatedId" : { + "required" : [ "id", "type" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique identifier for the associated object." + }, + "type" : { + "type" : "string", + "description" : "The type of associations.", + "example" : "deal_to_contact" + } + }, + "description" : "Contains the id and type of an association" + }, + "AssociationSpec" : { + "required" : [ "associationCategory", "associationTypeId" ], + "type" : "object", + "properties" : { + "associationCategory" : { + "type" : "string", + "description" : "The category of the association, indicating its origin or purpose. Valid values include \"HUBSPOT_DEFINED\", \"USER_DEFINED\", \"INTEGRATOR_DEFINED\", and \"WORK\".", + "enum" : [ "HUBSPOT_DEFINED", "INTEGRATOR_DEFINED", "USER_DEFINED", "WORK" ] + }, + "associationTypeId" : { + "type" : "integer", + "description" : "An integer representing the unique identifier for the type of association.", + "format" : "int32" + } + }, + "description" : "Defines the type, direction, and details of the relationship between two CRM objects." + }, + "BatchInputSimplePublicObjectBatchInput" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be processed in the batch operation. Each object in the array contains the data necessary for the specific operation being performed.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInput" + } + } + }, + "description" : "Represents a batch input component used to handle multiple simple public objects in a single API request. This component is typically used when performing batch operations to create, update, or delete multiple records simultaneously." + }, + "BatchInputSimplePublicObjectBatchInputForCreate" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be created. Each object in the array contains the necessary data for creating a new entry in the system.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInputForCreate" + } + } + }, + "description" : "Represents a batch input for creating multiple simple public objects in a single request. This component is used to streamline the process of adding new objects to a HubSpot account by allowing multiple entries to be created at once." + }, + "BatchInputSimplePublicObjectBatchInputUpsert" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be upserted. Each object in the array contains the necessary data for creating or updating a record in HubSpot.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInputUpsert" + } + } + }, + "description" : "Represents a batch input operation for upserting simple public objects in HubSpot. This component is used to process multiple upsert operations in a single request, improving efficiency and performance." + }, + "BatchInputSimplePublicObjectId" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public object IDs to be processed in the batch operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectId" + } + } + }, + "description" : "Represents a batch input payload containing a list of simple public object IDs. This component is used when performing batch operations on multiple objects within HubSpot." + }, + "BatchReadInputSimplePublicObjectId" : { + "required" : [ "inputs", "properties", "propertiesWithHistory" ], + "type" : "object", + "properties" : { + "idProperty" : { + "type" : "string", + "description" : "When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID." + }, + "inputs" : { + "type" : "array", + "description" : "An array of SimplePublicObjectId objects, each containing the ID of an object to be read.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectId" + } + }, + "properties" : { + "type" : "array", + "description" : "An array of the property names to be returned in the response. If a specified property is not present on the requested object(s), it will be ignored.", + "items" : { + "type" : "string" + } + }, + "propertiesWithHistory" : { + "type" : "array", + "description" : "An array of the property names to be returned along with their history of previous values. If a specified property is not present on the requested object(s), it will be ignored.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property." + }, + "BatchResponsePublicDefaultAssociation" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "description" : "An array of StandardError objects detailing any errors that occurred during the batch operation.", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "numErrors" : { + "type" : "integer", + "description" : "The total number of errors that occurred during the operation.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of PublicDefaultAssociation objects representing the results of the batch operation.", + "items" : { + "$ref" : "#/components/schemas/PublicDefaultAssociation" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "The response returned after performing a batch operation on associations." + }, + "BatchResponseSimplePublicObject" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch request was initially made, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of SimplePublicObject items representing the results of the batch operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing began, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request: \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\"", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "A public object batch response object" + }, + "BatchResponseSimplePublicObjectWithErrors" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "numErrors" : { + "type" : "integer", + "description" : "The number of errors encountered during the batch process.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request - \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\"", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the result of a batch operation on CRM objects, including the processing status, batch results, timestamps, and a list of any errors encountered during the operation." + }, + "BatchResponseSimplePublicUpsertObject" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of SimplePublicUpsertObject items representing the results of the batch upsert operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicUpsertObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects." + }, + "BatchResponseSimplePublicUpsertObjectWithErrors" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "numErrors" : { + "type" : "integer", + "description" : "The number of errors encountered during the batch process.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SimplePublicUpsertObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the response from a batch upsert operation, including the status, timestamps, successfully processed objects, and any errors that occurred during processing." + }, + "CollectionResponseAssociatedId" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/Paging" + }, + "results" : { + "type" : "array", + "description" : "A list of associated IDs retrieved from the API request.", + "items" : { + "$ref" : "#/components/schemas/AssociatedId" + } + } + }, + "description" : "Represents a collection of associated IDs returned by an API request, including pagination details for navigating through the results." + }, + "CollectionResponseSimplePublicObjectWithAssociationsForwardPaging" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/ForwardPaging" + }, + "results" : { + "type" : "array", + "description" : "An array of simple public objects that are included in the current page of the response. Each object may include its associated data.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations" + } + } + }, + "description" : "Represents a paginated collection response that includes simple public objects with their associations. This component is used to handle the results and pagination details when retrieving a list of objects from the API." + }, + "CollectionResponseWithTotalSimplePublicObject" : { + "required" : [ "results", "total" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/Paging" + }, + "results" : { + "type" : "array", + "description" : "An array containing the simple public objects returned in the current page of the response. This property is required.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "total" : { + "type" : "integer", + "description" : "The number of available results", + "format" : "int32" + } + }, + "description" : "Represents a list of simple objects returned from an API request, along with the total count of objects available." + }, + "Error" : { + "required" : [ "category", "correlationId", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The error category" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}" + }, + "correlationId" : { + "type" : "string", + "description" : "A unique identifier for the request. Include this value with any error reports or support tickets", + "format" : "uuid", + "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf" + }, + "errors" : { + "type" : "array", + "description" : "further information about the error", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps" + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate", + "example" : "An error occurred" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered.", + "example" : { + "message" : "Invalid input (details will vary based on the error)", + "correlationId" : "aeb5f871-7f07-4993-9211-075dc63e7cbf", + "category" : "VALIDATION_ERROR", + "links" : { + "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base" + } + } + }, + "ErrorDetail" : { + "required" : [ "message" ], + "type" : "object", + "properties" : { + "code" : { + "type" : "string", + "description" : "The status code associated with the error detail" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{missingScopes=[scope1, scope2]}" + }, + "in" : { + "type" : "string", + "description" : "The name of the field or parameter in which the error was found." + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response." + }, + "Filter" : { + "required" : [ "operator", "propertyName" ], + "type" : "object", + "properties" : { + "highValue" : { + "type" : "string", + "description" : "The upper boundary value when using ranged-based filters." + }, + "operator" : { + "type" : "string", + "description" : "The comparison operator used in the filter, such as \"EQ\" or \"GT\".", + "enum" : [ "BETWEEN", "CONTAINS_TOKEN", "EQ", "GT", "GTE", "HAS_PROPERTY", "IN", "LT", "LTE", "NEQ", "NOT_CONTAINS_TOKEN", "NOT_HAS_PROPERTY", "NOT_IN" ] + }, + "propertyName" : { + "type" : "string", + "description" : "The name of the property to apply the filter to." + }, + "value" : { + "type" : "string", + "description" : "The value to match against the property." + }, + "values" : { + "type" : "array", + "description" : "The values to match against the property.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against. " + }, + "FilterGroup" : { + "required" : [ "filters" ], + "type" : "object", + "properties" : { + "filters" : { + "type" : "array", + "description" : "A list of individual filter criteria that are applied together as a group. Each filter specifies a condition that records must meet to be included in the results.", + "items" : { + "$ref" : "#/components/schemas/Filter" + } + } + }, + "description" : "Represents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints." + }, + "ForwardPaging" : { + "type" : "object", + "properties" : { + "next" : { + "$ref" : "#/components/schemas/NextPage" + } + }, + "description" : "Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page." + }, + "LabelsBetweenObjectPair" : { + "required" : [ "fromObjectId", "fromObjectTypeId", "labels", "toObjectId", "toObjectTypeId" ], + "type" : "object", + "properties" : { + "fromObjectId" : { + "type" : "string", + "description" : "Source unique ID of the object." + }, + "fromObjectTypeId" : { + "type" : "string", + "description" : "Source object type." + }, + "labels" : { + "type" : "array", + "description" : "An array of labels that describe the relationship between the two objects. This is a required property.", + "items" : { + "type" : "string" + } + }, + "toObjectId" : { + "type" : "string", + "description" : "Target unique ID of the object." + }, + "toObjectTypeId" : { + "type" : "string", + "description" : "Target object type." + } + }, + "description" : "The relationship descriptors applicable between two object types." + }, + "NextPage" : { + "required" : [ "after" ], + "type" : "object", + "properties" : { + "after" : { + "type" : "string", + "description" : "A paging cursor token for retrieving subsequent pages." + }, + "link" : { + "type" : "string", + "description" : "A URL that can be used to retrieve the next page results." + } + }, + "description" : "Specifies the paging information needed to retrieve the next set of results in a paginated API response" + }, + "Paging" : { + "type" : "object", + "properties" : { + "next" : { + "$ref" : "#/components/schemas/NextPage" + }, + "prev" : { + "$ref" : "#/components/schemas/PreviousPage" + } + }, + "description" : "Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results." + }, + "PreviousPage" : { + "required" : [ "before" ], + "type" : "object", + "properties" : { + "before" : { + "type" : "string", + "description" : "A paging cursor token for retrieving previous pages." + }, + "link" : { + "type" : "string", + "description" : "A URL that can be used to retrieve the previous pages' results." + } + }, + "description" : "specifies the paging information needed to retrieve the previous set of results in a paginated API response" + }, + "PublicAssociationsForObject" : { + "required" : [ "to", "types" ], + "type" : "object", + "properties" : { + "to" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "types" : { + "type" : "array", + "description" : "The types of associations that exist between the object and other entities, indicating the nature of their relationship.", + "items" : { + "$ref" : "#/components/schemas/AssociationSpec" + } + } + }, + "description" : "Represents the associations for a specific object in HubSpot, detailing the types of associations and the related objects involved." + }, + "PublicDefaultAssociation" : { + "required" : [ "associationSpec", "from", "to" ], + "type" : "object", + "properties" : { + "associationSpec" : { + "$ref" : "#/components/schemas/AssociationSpec" + }, + "from" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "to" : { + "$ref" : "#/components/schemas/PublicObjectId" + } + }, + "description" : "The PublicDefaultAssociation component represents the default association configuration between two objects in HubSpot. It is used to define how objects are related to each other within the platform." + }, + "PublicObjectId" : { + "required" : [ "id" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + } + }, + "description" : "Contains the Id of a Public Object" + }, + "PublicObjectSearchRequest" : { + "required" : [ "after", "filterGroups", "limit", "properties", "sorts" ], + "type" : "object", + "properties" : { + "after" : { + "type" : "string", + "description" : "A paging cursor token for retrieving subsequent pages." + }, + "filterGroups" : { + "type" : "array", + "description" : "Up to 6 groups of filters defining additional query criteria.", + "items" : { + "$ref" : "#/components/schemas/FilterGroup" + } + }, + "limit" : { + "type" : "integer", + "description" : "The maximum results to return, up to 200 objects.", + "format" : "int32" + }, + "properties" : { + "type" : "array", + "description" : "A list of property names to include in the response.", + "items" : { + "type" : "string" + } + }, + "query" : { + "type" : "string", + "description" : "The search query string, up to 3000 characters." + }, + "sorts" : { + "type" : "array", + "description" : "Specifies sorting order based on object properties.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Describes a search request" + }, + "PublicObjectWarning" : { + "required" : [ "category", "context", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The classification of the warning, indicating the type or nature of the issue." + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Additional information or metadata about the warning, providing context for understanding the issue." + }, + "message" : { + "type" : "string", + "description" : "The text of the warning message, providing information about the issue or alert." + } + }, + "description" : "Represents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning." + }, + "SimplePublicObject" : { + "required" : [ "archived", "createdAt", "id", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used to trace the write request for the object. Set a unique ID for each write operation; it is returned with any errors so you can identify which request encountered which error." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history, each with a timestamp and source information." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL associated with the object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "A simple public object." + }, + "SimplePublicObjectBatchInput" : { + "required" : [ "id", "properties" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id to be updated. This can be the object id, or the unique property value of the idProperty property" + }, + "idProperty" : { + "type" : "string", + "description" : "The name of a property whose values are unique for this object", + "example" : "my_unique_property_name" + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "A unique identifier for tracing the request." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs representing the properties of the object." + } + }, + "description" : "Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties." + }, + "SimplePublicObjectBatchInputForCreate" : { + "required" : [ "associations", "properties" ], + "type" : "object", + "properties" : { + "associations" : { + "type" : "array", + "description" : "An array of associations that define the relationships between the objects being created and other existing objects. This property is required.", + "items" : { + "$ref" : "#/components/schemas/PublicAssociationsForObject" + } + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the creation or update request of the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "An input object that contains a collection of objects to be created together in a batch." + }, + "SimplePublicObjectBatchInputUpsert" : { + "required" : [ "id", "properties" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "idProperty" : { + "type" : "string", + "description" : "The name of a property whose values are unique for this object" + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier for tracing the creation request." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID." + }, + "SimplePublicObjectId" : { + "required" : [ "id" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object.", + "example" : "430001" + } + }, + "description" : "Contains the Id of a Public Object" + }, + "SimplePublicObjectInput" : { + "required" : [ "properties" ], + "type" : "object", + "properties" : { + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "Represents the input required to update a CRM object, containing an object with property names and their corresponding values." + }, + "SimplePublicObjectInputForCreate" : { + "required" : [ "associations", "properties" ], + "type" : "object", + "properties" : { + "associations" : { + "type" : "array", + "description" : "An array that specifies the relationships between the new public object and existing objects. This is required to establish how the new object is connected within the system.", + "items" : { + "$ref" : "#/components/schemas/PublicAssociationsForObject" + } + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs for setting properties for the new object." + } + }, + "description" : "Is the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects." + }, + "SimplePublicObjectWithAssociations" : { + "required" : [ "archived", "createdAt", "id", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "associations" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/CollectionResponseAssociatedId" + }, + "description" : "A map of associated object types to their associated IDs." + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the creation or update request of the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL link to access this object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type." + }, + "SimplePublicUpsertObject" : { + "required" : [ "archived", "createdAt", "id", "new", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "new" : { + "type" : "boolean", + "description" : "Whether the property is new." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the write request for the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL associated with the object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "Represents a CRM object that has either been created or updated (upserted)" + }, + "StandardError" : { + "required" : [ "category", "context", "errors", "links", "message", "status" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The main category of the error." + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Additional context-specific information related to the error." + }, + "errors" : { + "type" : "array", + "description" : "The detailed error objects.", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "id" : { + "type" : "string", + "description" : "A unique ID for the error instance." + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "URLs linking to documentation or resources associated with the error." + }, + "message" : { + "type" : "string", + "description" : "A human-readable string describing the error and possible remediation steps." + }, + "status" : { + "type" : "string", + "description" : "A text status code for the error, typically \"error\"." + }, + "subCategory" : { + "type" : "object", + "properties" : { }, + "description" : "A more specific error category within each main category." + } + }, + "description" : "Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request." + }, + "ValueWithTimestamp" : { + "required" : [ "sourceType", "timestamp", "value" ], + "type" : "object", + "properties" : { + "sourceId" : { + "type" : "string", + "description" : "A string identifier for the specific source of the value." + }, + "sourceLabel" : { + "type" : "string", + "description" : "A human-readable label." + }, + "sourceType" : { + "type" : "string", + "description" : "A string indicating the type of source from which the value originated." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp when the property was updated, in ISO 8601 format.", + "format" : "date-time" + }, + "updatedByUserId" : { + "type" : "integer", + "description" : "The ID of the user who last updated the property.", + "format" : "int32" + }, + "value" : { + "type" : "string", + "description" : "The property value." + } + }, + "description" : "Property model that includes timestamp." + } + }, + "responses" : { + "Error" : { + "description" : "An error occurred.", + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + } + } + } + }, + "securitySchemes" : { + "developer_hapikey" : { + "type" : "apiKey", + "name" : "hapikey", + "in" : "query" + }, + "oauth2" : { + "type" : "oauth2", + "flows" : { + "authorizationCode" : { + "authorizationUrl" : "https://app.hubspot.com/oauth/authorize", + "tokenUrl" : "https://api.hubapi.com/oauth/v1/token", + "scopes" : { + "cpq.price_books.read" : "", + "crm.objects.appointments.read" : "", + "crm.objects.appointments.sensitive.read.v2" : "", + "crm.objects.appointments.sensitive.write.v2" : "", + "crm.objects.appointments.write" : "", + "crm.objects.calls.read" : "", + "crm.objects.calls.write" : "", + "crm.objects.carts.read" : "", + "crm.objects.carts.write" : "", + "crm.objects.commercepayments.read" : "", + "crm.objects.commercepayments.write" : "", + "crm.objects.companies.highly_sensitive.read.v2" : "", + "crm.objects.companies.highly_sensitive.write.v2" : "", + "crm.objects.companies.read" : "", + "crm.objects.companies.sensitive.read.v2" : "", + "crm.objects.companies.sensitive.write.v2" : "", + "crm.objects.companies.write" : "", + "crm.objects.contacts.highly_sensitive.read.v2" : "", + "crm.objects.contacts.highly_sensitive.write.v2" : "", + "crm.objects.contacts.read" : "", + "crm.objects.contacts.sensitive.read.v2" : "", + "crm.objects.contacts.sensitive.write.v2" : "", + "crm.objects.contacts.write" : "", + "crm.objects.contracts.read" : "", + "crm.objects.courses.read" : "", + "crm.objects.courses.write" : "", + "crm.objects.custom.highly_sensitive.read.v2" : "", + "crm.objects.custom.highly_sensitive.write.v2" : "", + "crm.objects.custom.read" : "", + "crm.objects.custom.sensitive.read.v2" : "", + "crm.objects.custom.sensitive.write.v2" : "", + "crm.objects.custom.write" : "", + "crm.objects.deals.highly_sensitive.read.v2" : "", + "crm.objects.deals.highly_sensitive.write.v2" : "", + "crm.objects.deals.read" : "", + "crm.objects.deals.sensitive.read.v2" : "", + "crm.objects.deals.sensitive.write.v2" : "", + "crm.objects.deals.write" : "", + "crm.objects.emails.read" : "", + "crm.objects.emails.write" : "", + "crm.objects.feedback_submissions.read" : "", + "crm.objects.forecasts.read" : "", + "crm.objects.goals.read" : "", + "crm.objects.goals.write" : "", + "crm.objects.invoices.read" : "", + "crm.objects.invoices.write" : "", + "crm.objects.leads.read" : "", + "crm.objects.leads.write" : "", + "crm.objects.line_items.read" : "", + "crm.objects.line_items.write" : "", + "crm.objects.listings.read" : "", + "crm.objects.listings.write" : "", + "crm.objects.meetings.read" : "", + "crm.objects.meetings.write" : "", + "crm.objects.notes.read" : "", + "crm.objects.notes.write" : "", + "crm.objects.orders.read" : "", + "crm.objects.orders.write" : "", + "crm.objects.partner-clients.read" : "", + "crm.objects.partner-clients.write" : "", + "crm.objects.partner-services.read" : "", + "crm.objects.partner-services.write" : "", + "crm.objects.products.read" : "", + "crm.objects.products.write" : "", + "crm.objects.projects.highly_sensitive.read" : "", + "crm.objects.projects.highly_sensitive.write" : "", + "crm.objects.projects.read" : "", + "crm.objects.projects.sensitive.read" : "", + "crm.objects.projects.sensitive.write" : "", + "crm.objects.projects.write" : "", + "crm.objects.quotes.read" : "", + "crm.objects.quotes.write" : "", + "crm.objects.services.read" : "", + "crm.objects.services.write" : "", + "crm.objects.subscriptions.read" : "", + "crm.objects.subscriptions.write" : "", + "crm.objects.tasks.read" : "", + "crm.objects.tasks.write" : "", + "crm.objects.tickets.highly_sensitive.read" : "", + "crm.objects.tickets.highly_sensitive.write" : "", + "crm.objects.tickets.read" : "", + "crm.objects.tickets.sensitive.read" : "", + "crm.objects.tickets.sensitive.write" : "", + "crm.objects.tickets.write" : "", + "crm.objects.users.read" : "", + "crm.objects.users.write" : "", + "e-commerce" : "", + "media_bridge.read" : "", + "oauth" : "", + "revenue.contracts.read" : "", + "tickets.highly_sensitive.v2" : "", + "tickets.sensitive.v2" : "" + } + } + }, + "x-hubspot-app-availability" : { + "cpq.price_books.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.appointments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.commercepayments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.commercepayments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.companies.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.contacts.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contracts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.custom.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.feedback_submissions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.forecasts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-clients.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-clients.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.products.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.products.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "e-commerce" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "media_bridge.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "oauth" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "revenue.contracts.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "tickets.highly_sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "tickets.sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + } + } + } + } + }, + "x-hubspot-available-client-libraries" : [ "Node", "Python", "Ruby", "PHP" ], + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + } +} \ No newline at end of file diff --git a/spec/hubspot/openapi.json b/spec/hubspot/openapi.json deleted file mode 100644 index 2b322bb..0000000 --- a/spec/hubspot/openapi.json +++ /dev/null @@ -1,104 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { "title": "Example Comments", "version": "1" }, - "servers": [{ "url": "https://comments.example.invalid/v1" }], - "security": [{ "token": [] }], - "paths": { - "/comments": { - "get": { - "operationId": "listComments", - "tags": ["Comments"], - "summary": "List comments, newest first", - "parameters": [ - { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, - { "name": "start_cursor", "in": "query", "schema": { "type": "string" } } - ], - "responses": { - "200": { - "description": "A page of comments", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentList" } } } - } - } - }, - "post": { - "operationId": "createComment", - "tags": ["Comments"], - "summary": "Create a comment", - "requestBody": { - "required": true, - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewComment" } } } - }, - "responses": { - "201": { - "description": "The comment", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Comment" } } } - } - } - } - }, - "/comments/{comment_id}": { - "parameters": [{ "name": "comment_id", "in": "path", "required": true, "schema": { "type": "string" } }], - "get": { - "operationId": "getComment", - "tags": ["Comments"], - "summary": "Show one comment", - "responses": { - "200": { - "description": "The comment", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Comment" } } } - } - } - }, - "patch": { - "operationId": "updateComment", - "tags": ["Comments"], - "summary": "Change a comment's text", - "requestBody": { - "required": true, - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewComment" } } } - }, - "responses": { - "200": { - "description": "The comment", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Comment" } } } - } - } - }, - "delete": { - "operationId": "deleteComment", - "tags": ["Comments"], - "summary": "Delete a comment", - "responses": { "204": { "description": "Deleted" } } - } - } - }, - "components": { - "securitySchemes": { "token": { "type": "http", "scheme": "bearer" } }, - "schemas": { - "NewComment": { - "type": "object", - "required": ["text"], - "properties": { "text": { "type": "string", "minLength": 1 } } - }, - "Comment": { - "type": "object", - "required": ["id", "text", "author", "created_at"], - "properties": { - "id": { "type": "string" }, - "text": { "type": "string" }, - "author": { "type": "string" }, - "created_at": { "type": "string", "format": "date-time" } - } - }, - "CommentList": { - "type": "object", - "required": ["results", "has_more"], - "properties": { - "results": { "type": "array", "items": { "$ref": "#/components/schemas/Comment" } }, - "has_more": { "type": "boolean" }, - "next_cursor": { "type": ["string", "null"] } - } - } - } - } -} diff --git a/spec/hubspot/pipelines.json b/spec/hubspot/pipelines.json new file mode 100644 index 0000000..ca6b607 --- /dev/null +++ b/spec/hubspot/pipelines.json @@ -0,0 +1,3932 @@ +{ + "openapi" : "3.0.1", + "info" : { + "title" : "Pipelines", + "description" : "Basepom for all HubSpot Projects", + "version" : "2026-03", + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + }, + "x-hubspot-api-use-case" : "To streamline customer support processes, use this API to retrieve your existing ticket pipelines and add new stages based on your business needs. Support reps can then assign tickets to those pipeline stages to track progress on customer issues.", + "x-hubspot-introduction" : "Use the pipelines API to create and manage deal and ticket pipelines. Pipelines enable you to track the status or progress of deals and tickets, such as closing deals and opening support tickets." + }, + "servers" : [ { + "url" : "https://api.hubapi.com" + } ], + "tags" : [ { + "name" : "Basic" + } ], + "paths" : { + "/crm/pipelines/2026-03/{objectType}" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Retrieve all pipelines", + "description" : "Return all pipelines for the object type specified by `{objectType}`.", + "operationId" : "get-/crm/pipelines/2026-03/{objectType}_getAll", + "parameters" : [ { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponsePipelineNoPaging" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.owners.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.schemas.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.schemas.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.schemas.services.read" ] + }, { + "oauth2" : [ "crm.schemas.line_items.read" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.read" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "cpq.price_books.write" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.read" ] + }, { + "oauth2" : [ "crm.schemas.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.schemas.orders.read" ] + }, { + "oauth2" : [ "crm.schemas.emails.read" ] + }, { + "oauth2" : [ "crm.schemas.deals.read" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.notes.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.read" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.schemas.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.schemas.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.marketing_events.read" ] + }, { + "oauth2" : [ "crm.pipelines.orders.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "automation" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.read" ] + }, { + "oauth2" : [ "cpq.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.schemas.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.schemas.courses.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.pipelines.approval.read" ] + }, { + "oauth2" : [ "workflows.write" ] + }, { + "oauth2" : [ "crm.objects.marketing_events.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.read" ] + }, { + "oauth2" : [ "workflows.read" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.read" ] + } ] + }, + "post" : { + "tags" : [ "Basic" ], + "summary" : "Create a pipeline", + "description" : "Create a new pipeline with the provided property values. The entire pipeline object, including its unique ID, will be returned in the response.", + "operationId" : "post-/crm/pipelines/2026-03/{objectType}_create", + "parameters" : [ { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PipelineInput" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "headers" : { + "Location" : { + "description" : "URL of the newly created resource", + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Pipeline" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.invoices.write" ] + }, { + "oauth2" : [ "crm.schemas.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.write" ] + }, { + "oauth2" : [ "crm.schemas.courses.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.appointments.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.emails.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.write" ] + }, { + "oauth2" : [ "crm.pipelines.orders.write" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.schemas.services.write" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.notes.write" ] + }, { + "oauth2" : [ "crm.schemas.contracts.write" ] + }, { + "oauth2" : [ "crm.schemas.meetings.write" ] + }, { + "oauth2" : [ "crm.schemas.deals.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.write" ] + }, { + "oauth2" : [ "crm.schemas.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + } ] + } + }, + "/crm/pipelines/2026-03/{objectType}/{pipelineId}" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Return a pipeline by ID", + "description" : "Return a single pipeline object identified by its unique `{pipelineId}`.", + "operationId" : "get-/crm/pipelines/2026-03/{objectType}/{pipelineId}_getById", + "parameters" : [ { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "pipelineId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Pipeline" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.owners.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.schemas.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.schemas.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.schemas.services.read" ] + }, { + "oauth2" : [ "crm.schemas.line_items.read" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.read" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "cpq.price_books.write" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.read" ] + }, { + "oauth2" : [ "crm.schemas.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.schemas.orders.read" ] + }, { + "oauth2" : [ "crm.schemas.emails.read" ] + }, { + "oauth2" : [ "crm.schemas.deals.read" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.notes.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.read" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.schemas.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.schemas.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.marketing_events.read" ] + }, { + "oauth2" : [ "crm.pipelines.orders.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "automation" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.read" ] + }, { + "oauth2" : [ "cpq.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.schemas.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.schemas.courses.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.pipelines.approval.read" ] + }, { + "oauth2" : [ "workflows.write" ] + }, { + "oauth2" : [ "crm.objects.marketing_events.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.read" ] + }, { + "oauth2" : [ "workflows.read" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.read" ] + } ] + }, + "put" : { + "tags" : [ "Basic" ], + "summary" : "Replace a pipeline", + "description" : "Replace all properties of an existing pipeline with the provided values.", + "operationId" : "put-/crm/pipelines/2026-03/{objectType}/{pipelineId}_replace", + "parameters" : [ { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "pipelineId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "validateDealStageUsagesBeforeDelete", + "in" : "query", + "description" : "", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "validateReferencesBeforeDelete", + "in" : "query", + "description" : "", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PipelineReplaceInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Pipeline" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.invoices.write" ] + }, { + "oauth2" : [ "crm.schemas.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.write" ] + }, { + "oauth2" : [ "crm.schemas.courses.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.appointments.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.emails.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.write" ] + }, { + "oauth2" : [ "crm.pipelines.orders.write" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.schemas.services.write" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.notes.write" ] + }, { + "oauth2" : [ "crm.schemas.contracts.write" ] + }, { + "oauth2" : [ "crm.schemas.meetings.write" ] + }, { + "oauth2" : [ "crm.schemas.deals.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.write" ] + }, { + "oauth2" : [ "crm.schemas.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + } ] + }, + "delete" : { + "tags" : [ "Basic" ], + "summary" : "Delete a pipeline", + "description" : "Delete a pipeline identified by its unique pipelineId", + "operationId" : "delete-/crm/pipelines/2026-03/{objectType}/{pipelineId}_archive", + "parameters" : [ { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "pipelineId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "validateDealStageUsagesBeforeDelete", + "in" : "query", + "description" : "", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "validateReferencesBeforeDelete", + "in" : "query", + "description" : "", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.invoices.write" ] + }, { + "oauth2" : [ "crm.schemas.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.write" ] + }, { + "oauth2" : [ "crm.schemas.courses.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.appointments.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.emails.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.write" ] + }, { + "oauth2" : [ "crm.pipelines.orders.write" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.schemas.services.write" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.notes.write" ] + }, { + "oauth2" : [ "crm.schemas.contracts.write" ] + }, { + "oauth2" : [ "crm.schemas.meetings.write" ] + }, { + "oauth2" : [ "crm.schemas.deals.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.write" ] + }, { + "oauth2" : [ "crm.schemas.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + } ] + }, + "patch" : { + "tags" : [ "Basic" ], + "summary" : "Perform a partial update of the pipeline identified by pipelineId.", + "description" : "Perform a partial update of the pipeline identified by `{pipelineId}`. The updated pipeline will be returned in the response.", + "operationId" : "patch-/crm/pipelines/2026-03/{objectType}/{pipelineId}_update", + "parameters" : [ { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "pipelineId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "validateDealStageUsagesBeforeDelete", + "in" : "query", + "description" : "", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "validateReferencesBeforeDelete", + "in" : "query", + "description" : "", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PipelinePatchInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Pipeline" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.invoices.write" ] + }, { + "oauth2" : [ "crm.schemas.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.write" ] + }, { + "oauth2" : [ "crm.schemas.courses.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.appointments.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.emails.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.write" ] + }, { + "oauth2" : [ "crm.pipelines.orders.write" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.schemas.services.write" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.notes.write" ] + }, { + "oauth2" : [ "crm.schemas.contracts.write" ] + }, { + "oauth2" : [ "crm.schemas.meetings.write" ] + }, { + "oauth2" : [ "crm.schemas.deals.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.write" ] + }, { + "oauth2" : [ "crm.schemas.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + } ] + } + }, + "/crm/pipelines/2026-03/{objectType}/{pipelineId}/audit" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Return an audit of all changes to the pipeline", + "description" : "Return a reverse chronological list of all mutations that have occurred on the pipeline identified by `{pipelineId}`.", + "operationId" : "get-/crm/pipelines/2026-03/{objectType}/{pipelineId}/audit_getAudit", + "parameters" : [ { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "pipelineId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponsePublicAuditInfoNoPaging" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.owners.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.schemas.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.schemas.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.schemas.services.read" ] + }, { + "oauth2" : [ "crm.schemas.line_items.read" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.read" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "cpq.price_books.write" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.read" ] + }, { + "oauth2" : [ "crm.schemas.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.schemas.orders.read" ] + }, { + "oauth2" : [ "crm.schemas.emails.read" ] + }, { + "oauth2" : [ "crm.schemas.deals.read" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.notes.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.read" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.schemas.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.schemas.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.marketing_events.read" ] + }, { + "oauth2" : [ "crm.pipelines.orders.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "automation" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.read" ] + }, { + "oauth2" : [ "cpq.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.schemas.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.schemas.courses.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.pipelines.approval.read" ] + }, { + "oauth2" : [ "workflows.write" ] + }, { + "oauth2" : [ "crm.objects.marketing_events.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.read" ] + }, { + "oauth2" : [ "workflows.read" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.read" ] + } ] + } + }, + "/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Return all stages of a pipeline", + "description" : "Return all the stages associated with the pipeline identified by `{pipelineId}`.", + "operationId" : "get-/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages_getAll", + "parameters" : [ { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "pipelineId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponsePipelineStageNoPaging" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.owners.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.schemas.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.schemas.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.schemas.services.read" ] + }, { + "oauth2" : [ "crm.schemas.line_items.read" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.read" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "cpq.price_books.write" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.read" ] + }, { + "oauth2" : [ "crm.schemas.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.schemas.orders.read" ] + }, { + "oauth2" : [ "crm.schemas.emails.read" ] + }, { + "oauth2" : [ "crm.schemas.deals.read" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.notes.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.read" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.schemas.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.schemas.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.marketing_events.read" ] + }, { + "oauth2" : [ "crm.pipelines.orders.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "automation" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.read" ] + }, { + "oauth2" : [ "cpq.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.schemas.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.schemas.courses.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.pipelines.approval.read" ] + }, { + "oauth2" : [ "workflows.write" ] + }, { + "oauth2" : [ "crm.objects.marketing_events.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.read" ] + }, { + "oauth2" : [ "workflows.read" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.read" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "post" : { + "tags" : [ "Basic" ], + "summary" : "Create a pipeline stage", + "description" : "Create a new stage within the specified pipeline.", + "operationId" : "post-/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages_create", + "parameters" : [ { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "pipelineId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PipelineStageInput" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "headers" : { + "Location" : { + "description" : "URL of the newly created resource", + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PipelineStage" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.invoices.write" ] + }, { + "oauth2" : [ "crm.schemas.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.write" ] + }, { + "oauth2" : [ "crm.schemas.courses.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.appointments.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.emails.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.write" ] + }, { + "oauth2" : [ "crm.pipelines.orders.write" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.schemas.services.write" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.notes.write" ] + }, { + "oauth2" : [ "crm.schemas.contracts.write" ] + }, { + "oauth2" : [ "crm.schemas.meetings.write" ] + }, { + "oauth2" : [ "crm.schemas.deals.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.write" ] + }, { + "oauth2" : [ "crm.schemas.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + } ] + } + }, + "/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Return a pipeline stage by ID", + "description" : "Retrieve a specific stage from a pipeline using its ID.", + "operationId" : "get-/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}_getById", + "parameters" : [ { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "pipelineId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "stageId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PipelineStage" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.owners.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.schemas.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.schemas.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.schemas.services.read" ] + }, { + "oauth2" : [ "crm.schemas.line_items.read" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.read" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "cpq.price_books.write" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.read" ] + }, { + "oauth2" : [ "crm.schemas.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.schemas.orders.read" ] + }, { + "oauth2" : [ "crm.schemas.emails.read" ] + }, { + "oauth2" : [ "crm.schemas.deals.read" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.notes.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.read" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.schemas.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.schemas.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.marketing_events.read" ] + }, { + "oauth2" : [ "crm.pipelines.orders.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "automation" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.read" ] + }, { + "oauth2" : [ "cpq.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.schemas.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.schemas.courses.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.pipelines.approval.read" ] + }, { + "oauth2" : [ "workflows.write" ] + }, { + "oauth2" : [ "crm.objects.marketing_events.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.read" ] + }, { + "oauth2" : [ "workflows.read" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.read" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "put" : { + "tags" : [ "Basic" ], + "summary" : "Replace a pipeline stage", + "description" : "Replace all the properties of an existing pipeline stage with the values provided. The updated stage will be returned in the response.", + "operationId" : "put-/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}_replace", + "parameters" : [ { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "pipelineId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "stageId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PipelineStageReplaceInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PipelineStage" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.invoices.write" ] + }, { + "oauth2" : [ "crm.schemas.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.write" ] + }, { + "oauth2" : [ "crm.schemas.courses.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.appointments.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.emails.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.write" ] + }, { + "oauth2" : [ "crm.pipelines.orders.write" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.schemas.services.write" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.notes.write" ] + }, { + "oauth2" : [ "crm.schemas.contracts.write" ] + }, { + "oauth2" : [ "crm.schemas.meetings.write" ] + }, { + "oauth2" : [ "crm.schemas.deals.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.write" ] + }, { + "oauth2" : [ "crm.schemas.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + } ] + }, + "delete" : { + "tags" : [ "Basic" ], + "summary" : "Delete a pipeline stage", + "description" : "Delete a specific stage from a pipeline.", + "operationId" : "delete-/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}_archive", + "parameters" : [ { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "pipelineId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "stageId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "validateReferencesBeforeDelete", + "in" : "query", + "description" : "", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.invoices.write" ] + }, { + "oauth2" : [ "crm.schemas.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.write" ] + }, { + "oauth2" : [ "crm.schemas.courses.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.appointments.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.emails.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.write" ] + }, { + "oauth2" : [ "crm.pipelines.orders.write" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.schemas.services.write" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.notes.write" ] + }, { + "oauth2" : [ "crm.schemas.contracts.write" ] + }, { + "oauth2" : [ "crm.schemas.meetings.write" ] + }, { + "oauth2" : [ "crm.schemas.deals.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.write" ] + }, { + "oauth2" : [ "crm.schemas.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + } ] + }, + "patch" : { + "tags" : [ "Basic" ], + "summary" : "Update specific properties of an existing pipeline stage.", + "description" : "Perform a partial update on a specific stage of a pipeline.", + "operationId" : "patch-/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}_update", + "parameters" : [ { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "pipelineId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "stageId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PipelineStagePatchInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PipelineStage" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.invoices.write" ] + }, { + "oauth2" : [ "crm.schemas.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.write" ] + }, { + "oauth2" : [ "crm.schemas.courses.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.appointments.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.emails.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.write" ] + }, { + "oauth2" : [ "crm.pipelines.orders.write" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.schemas.services.write" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.notes.write" ] + }, { + "oauth2" : [ "crm.schemas.contracts.write" ] + }, { + "oauth2" : [ "crm.schemas.meetings.write" ] + }, { + "oauth2" : [ "crm.schemas.deals.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.write" ] + }, { + "oauth2" : [ "crm.schemas.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + } ] + } + }, + "/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}/audit" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Retrieve a reverse chronological list of all changes made to a specific pipeline stage.", + "description" : "Return a reverse chronological list of all mutations that have occurred on the pipeline stage identified by `{stageId}`.", + "operationId" : "get-/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}/audit_getAudit", + "parameters" : [ { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "pipelineId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + }, { + "name" : "stageId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponsePublicAuditInfoNoPaging" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.owners.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.schemas.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.schemas.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.schemas.services.read" ] + }, { + "oauth2" : [ "crm.schemas.line_items.read" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.read" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "cpq.price_books.write" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.read" ] + }, { + "oauth2" : [ "crm.schemas.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.schemas.orders.read" ] + }, { + "oauth2" : [ "crm.schemas.emails.read" ] + }, { + "oauth2" : [ "crm.schemas.deals.read" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.notes.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.read" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.schemas.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.schemas.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.marketing_events.read" ] + }, { + "oauth2" : [ "crm.pipelines.orders.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "automation" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.read" ] + }, { + "oauth2" : [ "cpq.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.schemas.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.schemas.courses.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.pipelines.approval.read" ] + }, { + "oauth2" : [ "workflows.write" ] + }, { + "oauth2" : [ "crm.objects.marketing_events.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.read" ] + }, { + "oauth2" : [ "workflows.read" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.read" ] + } ] + } + } + }, + "components" : { + "schemas" : { + "CollectionResponsePipelineNoPaging" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Pipeline" + } + } + } + }, + "CollectionResponsePipelineStageNoPaging" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PipelineStage" + } + } + } + }, + "CollectionResponsePublicAuditInfoNoPaging" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicAuditInfo" + } + } + } + }, + "Error" : { + "required" : [ "category", "correlationId", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The error category" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}" + }, + "correlationId" : { + "type" : "string", + "description" : "A unique identifier for the request. Include this value with any error reports or support tickets", + "format" : "uuid", + "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf" + }, + "errors" : { + "type" : "array", + "description" : "further information about the error", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps" + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate", + "example" : "An error occurred" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered.", + "example" : { + "message" : "Invalid input (details will vary based on the error)", + "correlationId" : "aeb5f871-7f07-4993-9211-075dc63e7cbf", + "category" : "VALIDATION_ERROR", + "links" : { + "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base" + } + } + }, + "ErrorDetail" : { + "required" : [ "message" ], + "type" : "object", + "properties" : { + "code" : { + "type" : "string", + "description" : "The status code associated with the error detail" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{missingScopes=[scope1, scope2]}" + }, + "in" : { + "type" : "string", + "description" : "The name of the field or parameter in which the error was found." + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response." + }, + "Pipeline" : { + "required" : [ "archived", "createdAt", "displayOrder", "id", "label", "stages", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the pipeline is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The date the pipeline was archived. `archivedAt` will only be present if the pipeline is archived.", + "format" : "date-time" + }, + "createdAt" : { + "type" : "string", + "description" : "The date the pipeline was created. The default pipelines will have createdAt = 0.", + "format" : "date-time" + }, + "displayOrder" : { + "type" : "integer", + "description" : "The order for displaying this pipeline. If two pipelines have a matching `displayOrder`, they will be sorted alphabetically by label.", + "format" : "int32" + }, + "id" : { + "type" : "string", + "description" : "A unique identifier generated by HubSpot that can be used to retrieve and update the pipeline." + }, + "label" : { + "type" : "string", + "description" : "A unique label used to organize pipelines in HubSpot's UI" + }, + "stages" : { + "type" : "array", + "description" : "The stages associated with the pipeline. They can be retrieved and updated via the pipeline stages endpoints.", + "items" : { + "$ref" : "#/components/schemas/PipelineStage" + } + }, + "updatedAt" : { + "type" : "string", + "description" : "The date the pipeline was last updated.", + "format" : "date-time" + } + } + }, + "PipelineInput" : { + "required" : [ "displayOrder", "label", "stages" ], + "type" : "object", + "properties" : { + "displayOrder" : { + "type" : "integer", + "description" : "The order for displaying this pipeline. If two pipelines have a matching `displayOrder`, they will be sorted alphabetically by label.", + "format" : "int32" + }, + "label" : { + "type" : "string", + "description" : "A unique label used to organize pipelines in HubSpot's UI" + }, + "pipelineId" : { + "type" : "string" + }, + "stages" : { + "type" : "array", + "description" : "Pipeline stage inputs used to create the new or replacement pipeline.", + "items" : { + "$ref" : "#/components/schemas/PipelineStageInput" + } + } + } + }, + "PipelinePatchInput" : { + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the pipeline is archived. This property should only be provided when restoring an archived pipeline. If it's provided in any other call, the request will fail and a `400 Bad Request` will be returned." + }, + "displayOrder" : { + "type" : "integer", + "description" : "The order for displaying this pipeline. If two pipelines have a matching `displayOrder`, they will be sorted alphabetically by label.", + "format" : "int32" + }, + "label" : { + "type" : "string", + "description" : "A unique label used to organize pipelines in HubSpot's UI" + } + } + }, + "PipelineReplaceInput" : { + "required" : [ "displayOrder", "label", "stages" ], + "type" : "object", + "properties" : { + "displayOrder" : { + "type" : "integer", + "description" : "The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label.", + "format" : "int32" + }, + "label" : { + "type" : "string", + "description" : "A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline." + }, + "stages" : { + "type" : "array", + "description" : "The stages associated with the pipeline. They can be retrieved and updated via the pipeline stages endpoints.", + "items" : { + "$ref" : "#/components/schemas/PipelineStageInput" + } + } + } + }, + "PipelineStage" : { + "required" : [ "archived", "createdAt", "displayOrder", "id", "label", "metadata", "updatedAt", "writePermissions" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the pipeline is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The date the pipeline was archived. `archivedAt` will only be present if the pipeline is archived.", + "format" : "date-time" + }, + "createdAt" : { + "type" : "string", + "description" : "The date the pipeline stage was created. The stages on default pipelines will have createdAt = 0.", + "format" : "date-time" + }, + "displayOrder" : { + "type" : "integer", + "description" : "The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label.", + "format" : "int32" + }, + "id" : { + "type" : "string", + "description" : "A unique identifier generated by HubSpot that can be used to retrieve and update the pipeline stage." + }, + "label" : { + "type" : "string", + "description" : "A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline." + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A JSON object containing properties that are not present on all object pipelines.\n\nFor `deals` pipelines, the `probability` field is required (`{ \"probability\": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1.\n\nFor `tickets` pipelines, the `ticketState` field is optional (`{ \"ticketState\": \"OPEN\" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`." + }, + "updatedAt" : { + "type" : "string", + "description" : "The date the pipeline stage was last updated.", + "format" : "date-time" + }, + "writePermissions" : { + "type" : "string", + "description" : "Defines the level of write access for the pipeline stage, with possible values being CRM_PERMISSIONS_ENFORCEMENT, READ_ONLY, or INTERNAL_ONLY.", + "enum" : [ "CRM_PERMISSIONS_ENFORCEMENT", "INTERNAL_ONLY", "READ_ONLY" ] + } + } + }, + "PipelineStageInput" : { + "required" : [ "displayOrder", "label", "metadata" ], + "type" : "object", + "properties" : { + "displayOrder" : { + "type" : "integer", + "description" : "The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label.", + "format" : "int32" + }, + "label" : { + "type" : "string", + "description" : "A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline." + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A JSON object containing properties that are not present on all object pipelines.\n\nFor `deals` pipelines, the `probability` field is required (`{ \"probability\": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1.\n\nFor `tickets` pipelines, the `ticketState` field is optional (`{ \"ticketState\": \"OPEN\" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`." + }, + "stageId" : { + "type" : "string" + } + } + }, + "PipelineStagePatchInput" : { + "required" : [ "metadata" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the pipeline is archived." + }, + "displayOrder" : { + "type" : "integer", + "description" : "The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label.", + "format" : "int32" + }, + "label" : { + "type" : "string", + "description" : "A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline." + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A JSON object containing properties that are not present on all object pipelines.\n\nFor `deals` pipelines, the `probability` field is required (`{ \"probability\": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1.\n\nFor `tickets` pipelines, the `ticketState` field is optional (`{ \"ticketState\": \"OPEN\" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`." + } + } + }, + "PipelineStageReplaceInput" : { + "required" : [ "displayOrder", "label", "metadata" ], + "type" : "object", + "properties" : { + "displayOrder" : { + "type" : "integer", + "description" : "The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label.", + "format" : "int32" + }, + "label" : { + "type" : "string", + "description" : "A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline." + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A JSON object containing properties that are not present on all object pipelines.\n\nFor `deals` pipelines, the `probability` field is required (`{ \"probability\": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1.\n\nFor `tickets` pipelines, the `ticketState` field is optional (`{ \"ticketState\": \"OPEN\" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`." + } + } + }, + "PublicAuditInfo" : { + "required" : [ "action", "identifier", "portalId" ], + "type" : "object", + "properties" : { + "action" : { + "type" : "string", + "description" : "The action performed that triggered the audit event." + }, + "fromUserId" : { + "type" : "integer", + "description" : "The ID of the user who initiated the audit event.", + "format" : "int32" + }, + "identifier" : { + "type" : "string", + "description" : "A unique string identifier for the audit event." + }, + "message" : { + "type" : "string", + "description" : "A descriptive message related to the audit event." + }, + "portalId" : { + "type" : "integer", + "description" : "The unique identifier for the HubSpot portal where the audit event occurred.", + "format" : "int32" + }, + "rawObject" : { + "type" : "object", + "properties" : { }, + "description" : "An object containing the raw data associated with the audit event." + }, + "timestamp" : { + "type" : "string", + "description" : "The date and time when the audit event took place.", + "format" : "date-time" + } + } + } + }, + "responses" : { + "Error" : { + "description" : "An error occurred.", + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + } + } + } + }, + "securitySchemes" : { + "developer_hapikey" : { + "type" : "apiKey", + "name" : "hapikey", + "in" : "query" + }, + "oauth2" : { + "type" : "oauth2", + "flows" : { + "authorizationCode" : { + "authorizationUrl" : "https://app.hubspot.com/oauth/authorize", + "tokenUrl" : "https://api.hubapi.com/oauth/v1/token", + "scopes" : { + "automation" : "", + "cpq.price_books.read" : "", + "cpq.price_books.write" : "", + "cpq.quotes.read" : "", + "cpq.quotes.write" : "", + "crm.objects.appointments.read" : "", + "crm.objects.appointments.sensitive.read.v2" : "", + "crm.objects.appointments.sensitive.write.v2" : "", + "crm.objects.appointments.write" : "", + "crm.objects.calls.read" : "", + "crm.objects.calls.write" : "", + "crm.objects.carts.read" : "", + "crm.objects.carts.write" : "", + "crm.objects.commercepayments.write" : "", + "crm.objects.companies.highly_sensitive.read.v2" : "", + "crm.objects.companies.highly_sensitive.write.v2" : "", + "crm.objects.companies.read" : "", + "crm.objects.companies.sensitive.read.v2" : "", + "crm.objects.companies.sensitive.write.v2" : "", + "crm.objects.companies.write" : "", + "crm.objects.contacts.highly_sensitive.read.v2" : "", + "crm.objects.contacts.highly_sensitive.write.v2" : "", + "crm.objects.contacts.read" : "", + "crm.objects.contacts.sensitive.read.v2" : "", + "crm.objects.contacts.sensitive.write.v2" : "", + "crm.objects.contacts.write" : "", + "crm.objects.contracts.read" : "", + "crm.objects.courses.read" : "", + "crm.objects.courses.write" : "", + "crm.objects.custom.highly_sensitive.read.v2" : "", + "crm.objects.custom.highly_sensitive.write.v2" : "", + "crm.objects.custom.read" : "", + "crm.objects.custom.sensitive.read.v2" : "", + "crm.objects.custom.sensitive.write.v2" : "", + "crm.objects.custom.write" : "", + "crm.objects.deals.highly_sensitive.read.v2" : "", + "crm.objects.deals.highly_sensitive.write.v2" : "", + "crm.objects.deals.read" : "", + "crm.objects.deals.sensitive.read.v2" : "", + "crm.objects.deals.sensitive.write.v2" : "", + "crm.objects.deals.write" : "", + "crm.objects.emails.read" : "", + "crm.objects.emails.write" : "", + "crm.objects.feedback_submissions.read" : "", + "crm.objects.forecasts.read" : "", + "crm.objects.goals.read" : "", + "crm.objects.goals.write" : "", + "crm.objects.invoices.read" : "", + "crm.objects.invoices.write" : "", + "crm.objects.leads.read" : "", + "crm.objects.leads.write" : "", + "crm.objects.line_items.read" : "", + "crm.objects.line_items.write" : "", + "crm.objects.listings.read" : "", + "crm.objects.listings.write" : "", + "crm.objects.marketing_events.read" : "", + "crm.objects.marketing_events.write" : "", + "crm.objects.meetings.read" : "", + "crm.objects.meetings.write" : "", + "crm.objects.notes.read" : "", + "crm.objects.notes.write" : "", + "crm.objects.orders.read" : "", + "crm.objects.orders.write" : "", + "crm.objects.owners.read" : "", + "crm.objects.products.write" : "", + "crm.objects.projects.highly_sensitive.read" : "", + "crm.objects.projects.highly_sensitive.write" : "", + "crm.objects.projects.read" : "", + "crm.objects.projects.sensitive.read" : "", + "crm.objects.projects.sensitive.write" : "", + "crm.objects.projects.write" : "", + "crm.objects.quotes.read" : "", + "crm.objects.quotes.write" : "", + "crm.objects.services.read" : "", + "crm.objects.services.write" : "", + "crm.objects.subscriptions.read" : "", + "crm.objects.subscriptions.write" : "", + "crm.objects.tasks.read" : "", + "crm.objects.tasks.write" : "", + "crm.objects.tickets.highly_sensitive.read" : "", + "crm.objects.tickets.highly_sensitive.write" : "", + "crm.objects.tickets.read" : "", + "crm.objects.tickets.sensitive.read" : "", + "crm.objects.tickets.sensitive.write" : "", + "crm.objects.tickets.write" : "", + "crm.objects.users.read" : "", + "crm.objects.users.write" : "", + "crm.pipelines.approval.read" : "", + "crm.pipelines.orders.read" : "", + "crm.pipelines.orders.write" : "", + "crm.schemas.appointments.read" : "", + "crm.schemas.appointments.write" : "", + "crm.schemas.calls.read" : "", + "crm.schemas.calls.write" : "", + "crm.schemas.carts.read" : "", + "crm.schemas.carts.write" : "", + "crm.schemas.commercepayments.read" : "", + "crm.schemas.commercepayments.write" : "", + "crm.schemas.companies.read" : "", + "crm.schemas.companies.write" : "", + "crm.schemas.contacts.read" : "", + "crm.schemas.contacts.write" : "", + "crm.schemas.contracts.read" : "", + "crm.schemas.contracts.write" : "", + "crm.schemas.courses.read" : "", + "crm.schemas.courses.write" : "", + "crm.schemas.custom.read" : "", + "crm.schemas.custom.write" : "", + "crm.schemas.deals.read" : "", + "crm.schemas.deals.write" : "", + "crm.schemas.emails.read" : "", + "crm.schemas.emails.write" : "", + "crm.schemas.forecasts.read" : "", + "crm.schemas.invoices.read" : "", + "crm.schemas.invoices.write" : "", + "crm.schemas.line_items.read" : "", + "crm.schemas.listings.read" : "", + "crm.schemas.listings.write" : "", + "crm.schemas.meetings.read" : "", + "crm.schemas.meetings.write" : "", + "crm.schemas.notes.read" : "", + "crm.schemas.notes.write" : "", + "crm.schemas.orders.read" : "", + "crm.schemas.orders.write" : "", + "crm.schemas.projects.read" : "", + "crm.schemas.projects.write" : "", + "crm.schemas.quotes.read" : "", + "crm.schemas.quotes.write" : "", + "crm.schemas.services.read" : "", + "crm.schemas.services.write" : "", + "crm.schemas.subscriptions.read" : "", + "crm.schemas.subscriptions.write" : "", + "crm.schemas.tasks.read" : "", + "crm.schemas.tasks.write" : "", + "crm.schemas.tickets.read" : "", + "crm.schemas.tickets.write" : "", + "e-commerce" : "", + "media_bridge.read" : "", + "tickets.highly_sensitive.v2" : "", + "tickets.sensitive.v2" : "", + "workflows.read" : "", + "workflows.write" : "" + } + } + }, + "x-hubspot-app-availability" : { + "automation" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "cpq.price_books.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "cpq.price_books.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "cpq.quotes.read" : { + "portal" : [ "public" ], + "user" : [ "public" ], + "developer" : false + }, + "cpq.quotes.write" : { + "portal" : [ "public" ], + "user" : [ "public" ], + "developer" : false + }, + "crm.objects.appointments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.commercepayments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.companies.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.contacts.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contracts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.custom.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.feedback_submissions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.forecasts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.marketing_events.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.marketing_events.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.owners.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.products.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.pipelines.approval.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.pipelines.orders.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.pipelines.orders.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.appointments.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.appointments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.calls.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.calls.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.carts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.carts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.commercepayments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.commercepayments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.companies.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.schemas.companies.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.contacts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.schemas.contacts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.contracts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.contracts.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.courses.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.courses.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.custom.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.schemas.custom.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.schemas.deals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.schemas.deals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.emails.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.emails.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.forecasts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.invoices.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.invoices.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.line_items.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.listings.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.listings.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.meetings.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.meetings.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.notes.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.notes.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.orders.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.orders.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.projects.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.projects.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.quotes.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.quotes.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.subscriptions.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.subscriptions.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.tasks.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.tasks.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.tickets.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.tickets.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "e-commerce" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "media_bridge.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "tickets.highly_sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "tickets.sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "workflows.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "workflows.write" : { + "user" : [ "public", "private" ], + "developer" : false + } + } + } + } + }, + "x-hubspot-available-client-libraries" : [ "Node", "Python", "Ruby", "PHP" ], + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + } +} \ No newline at end of file diff --git a/spec/hubspot/properties.json b/spec/hubspot/properties.json new file mode 100644 index 0000000..1ac6b0d --- /dev/null +++ b/spec/hubspot/properties.json @@ -0,0 +1,4008 @@ +{ + "openapi" : "3.0.1", + "info" : { + "title" : "Properties", + "description" : "Basepom for all HubSpot Projects", + "version" : "2026-03", + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + }, + "x-hubspot-api-use-case" : "Create a set of custom multi-select properties for storing contract data on company records.", + "x-hubspot-introduction" : "Use the properties API to store information in fields on individual contact records. You can use this API to manage existing default and custom properties, create new custom properties, and more." + }, + "servers" : [ { + "url" : "https://api.hubapi.com" + } ], + "tags" : [ { + "name" : "Basic" + }, { + "name" : "Batch" + } ], + "paths" : { + "/crm/properties/2026-03/{objectType}" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Read all properties", + "description" : "Read all existing properties for the specified object type and HubSpot account.", + "operationId" : "get-/crm/properties/2026-03/{objectType}_/crm/properties/2025-09/{objectType}", + "parameters" : [ { + "name" : "objectType", + "in" : "path", + "description" : "The type of CRM object for which properties are being retrieved, such as 'contacts', 'companies', etc.", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "dataSensitivity", + "in" : "query", + "description" : "Filter properties based on data sensitivity level. Valid values are 'non_sensitive', 'sensitive', and 'highly_sensitive'. Defaults to 'non_sensitive'.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "non_sensitive", + "enum" : [ "highly_sensitive", "non_sensitive", "sensitive" ] + } + }, { + "name" : "locale", + "in" : "query", + "description" : "Specify the locale to retrieve properties in a particular language or regional format.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "properties", + "in" : "query", + "description" : "A comma-separated list of property names to include in the response.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponsePropertyNoPaging" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.owners.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.schemas.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.schemas.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.schemas.services.read" ] + }, { + "oauth2" : [ "crm.schemas.line_items.read" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.read" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "cpq.price_books.write" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.read" ] + }, { + "oauth2" : [ "crm.schemas.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.schemas.orders.read" ] + }, { + "oauth2" : [ "crm.schemas.emails.read" ] + }, { + "oauth2" : [ "crm.schemas.deals.read" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.notes.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.read" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.schemas.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.schemas.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.marketing_events.read" ] + }, { + "oauth2" : [ "crm.pipelines.orders.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "automation" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.read" ] + }, { + "oauth2" : [ "cpq.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.schemas.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.schemas.courses.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.pipelines.approval.read" ] + }, { + "oauth2" : [ "workflows.write" ] + }, { + "oauth2" : [ "crm.objects.marketing_events.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.read" ] + }, { + "oauth2" : [ "workflows.read" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.read" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "post" : { + "tags" : [ "Basic" ], + "summary" : "Create a property", + "description" : "Create and return a copy of a new property for the specified object type.", + "operationId" : "post-/crm/properties/2026-03/{objectType}_/crm/properties/2025-09/{objectType}", + "parameters" : [ { + "name" : "objectType", + "in" : "path", + "description" : "The type of object for which the property is being created, such as contacts, companies, or deals.", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PropertyCreate" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "headers" : { + "Location" : { + "description" : "URL of the newly created resource", + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Property" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.invoices.write" ] + }, { + "oauth2" : [ "crm.schemas.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.write" ] + }, { + "oauth2" : [ "crm.schemas.courses.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.appointments.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.emails.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.write" ] + }, { + "oauth2" : [ "crm.pipelines.orders.write" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.schemas.services.write" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.notes.write" ] + }, { + "oauth2" : [ "crm.schemas.contracts.write" ] + }, { + "oauth2" : [ "crm.schemas.meetings.write" ] + }, { + "oauth2" : [ "crm.schemas.deals.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.write" ] + }, { + "oauth2" : [ "crm.schemas.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/properties/2026-03/{objectType}/batch/archive" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Archive a batch of properties", + "description" : "Archive a provided list of properties. This method will return a 204 No Content response on success regardless of the initial state of the property (e.g. active, already archived, non-existent).", + "operationId" : "post-/crm/properties/2026-03/{objectType}/batch/archive_/crm/properties/2025-09/{objectType}/batch/archive", + "parameters" : [ { + "name" : "objectType", + "in" : "path", + "description" : "The type of object whose properties are to be archived. This is a required parameter and identifies the specific object type within HubSpot.", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputPropertyName" + } + } + }, + "required" : true + }, + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.invoices.write" ] + }, { + "oauth2" : [ "crm.schemas.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.write" ] + }, { + "oauth2" : [ "crm.schemas.courses.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.appointments.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.emails.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.write" ] + }, { + "oauth2" : [ "crm.pipelines.orders.write" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.schemas.services.write" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.notes.write" ] + }, { + "oauth2" : [ "crm.schemas.contracts.write" ] + }, { + "oauth2" : [ "crm.schemas.meetings.write" ] + }, { + "oauth2" : [ "crm.schemas.deals.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.write" ] + }, { + "oauth2" : [ "crm.schemas.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + } ] + } + }, + "/crm/properties/2026-03/{objectType}/batch/create" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Create a batch of properties", + "description" : "Create a batch of properties using the same rules as when creating an individual property.", + "operationId" : "post-/crm/properties/2026-03/{objectType}/batch/create_/crm/properties/2025-09/{objectType}/batch/create", + "parameters" : [ { + "name" : "objectType", + "in" : "path", + "description" : "The type of CRM object for which the properties are being created, such as contacts, companies, or deals.", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputPropertyCreate" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseProperty" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponsePropertyWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.invoices.write" ] + }, { + "oauth2" : [ "crm.schemas.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.write" ] + }, { + "oauth2" : [ "crm.schemas.courses.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.appointments.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.emails.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.write" ] + }, { + "oauth2" : [ "crm.pipelines.orders.write" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.schemas.services.write" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.notes.write" ] + }, { + "oauth2" : [ "crm.schemas.contracts.write" ] + }, { + "oauth2" : [ "crm.schemas.meetings.write" ] + }, { + "oauth2" : [ "crm.schemas.deals.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.write" ] + }, { + "oauth2" : [ "crm.schemas.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/properties/2026-03/{objectType}/batch/read" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Read a batch of properties", + "description" : "Read a provided list of properties.", + "operationId" : "post-/crm/properties/2026-03/{objectType}/batch/read_/crm/properties/2025-09/{objectType}/batch/read", + "parameters" : [ { + "name" : "objectType", + "in" : "path", + "description" : "The type of CRM object for which properties are being retrieved. This is a required path parameter.", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "locale", + "in" : "query", + "description" : "A string specifying the locale to use for the response. This can be used to tailor the response to a specific language or region.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchReadInputPropertyName" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseProperty" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponsePropertyWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.owners.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.schemas.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.schemas.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.schemas.services.read" ] + }, { + "oauth2" : [ "crm.schemas.line_items.read" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.read" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "cpq.price_books.write" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.read" ] + }, { + "oauth2" : [ "crm.schemas.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.schemas.orders.read" ] + }, { + "oauth2" : [ "crm.schemas.emails.read" ] + }, { + "oauth2" : [ "crm.schemas.deals.read" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.notes.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.read" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.schemas.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.schemas.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.marketing_events.read" ] + }, { + "oauth2" : [ "crm.pipelines.orders.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "automation" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.read" ] + }, { + "oauth2" : [ "cpq.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.schemas.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.schemas.courses.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.pipelines.approval.read" ] + }, { + "oauth2" : [ "workflows.write" ] + }, { + "oauth2" : [ "crm.objects.marketing_events.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.read" ] + }, { + "oauth2" : [ "workflows.read" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.read" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/properties/2026-03/{objectType}/groups" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Read all property groups", + "description" : "Read all existing property groups for the specified object type and HubSpot account.", + "operationId" : "get-/crm/properties/2026-03/{objectType}/groups_/crm/properties/2025-09/{objectType}/groups", + "parameters" : [ { + "name" : "objectType", + "in" : "path", + "description" : "The type of CRM object for which to retrieve property groups, such as 'contacts' or 'deals'.", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "locale", + "in" : "query", + "description" : "The language locale to use for property group labels. This can help in displaying labels in the preferred language.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponsePropertyGroupNoPaging" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.owners.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.schemas.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.schemas.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.schemas.services.read" ] + }, { + "oauth2" : [ "crm.schemas.line_items.read" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.read" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "cpq.price_books.write" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.read" ] + }, { + "oauth2" : [ "crm.schemas.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.schemas.orders.read" ] + }, { + "oauth2" : [ "crm.schemas.emails.read" ] + }, { + "oauth2" : [ "crm.schemas.deals.read" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.notes.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.read" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.schemas.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.schemas.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.marketing_events.read" ] + }, { + "oauth2" : [ "crm.pipelines.orders.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "automation" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.read" ] + }, { + "oauth2" : [ "cpq.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.schemas.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.schemas.courses.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.pipelines.approval.read" ] + }, { + "oauth2" : [ "workflows.write" ] + }, { + "oauth2" : [ "crm.objects.marketing_events.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.read" ] + }, { + "oauth2" : [ "workflows.read" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.read" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "post" : { + "tags" : [ "Basic" ], + "summary" : "Create a property group", + "description" : "Create and return a copy of a new property group.", + "operationId" : "post-/crm/properties/2026-03/{objectType}/groups_/crm/properties/2025-09/{objectType}/groups", + "parameters" : [ { + "name" : "objectType", + "in" : "path", + "description" : "The type of object for which the property group is being created, such as contacts, companies, or deals.", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PropertyGroupCreate" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "headers" : { + "Location" : { + "description" : "URL of the newly created resource", + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PropertyGroup" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.invoices.write" ] + }, { + "oauth2" : [ "crm.schemas.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.write" ] + }, { + "oauth2" : [ "crm.schemas.courses.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.appointments.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.emails.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.write" ] + }, { + "oauth2" : [ "crm.pipelines.orders.write" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.schemas.services.write" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.notes.write" ] + }, { + "oauth2" : [ "crm.schemas.contracts.write" ] + }, { + "oauth2" : [ "crm.schemas.meetings.write" ] + }, { + "oauth2" : [ "crm.schemas.deals.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.write" ] + }, { + "oauth2" : [ "crm.schemas.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/properties/2026-03/{objectType}/groups/{groupName}" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Read a property group", + "description" : "Read a property group identified by {groupName}.", + "operationId" : "get-/crm/properties/2026-03/{objectType}/groups/{groupName}_/crm/properties/2025-09/{objectType}/groups/{groupName}", + "parameters" : [ { + "name" : "groupName", + "in" : "path", + "description" : "The name of the property group to retrieve details for.", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "The type of CRM object for which the property group is being retrieved, such as contacts or deals.", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "locale", + "in" : "query", + "description" : "The language locale to use for the response. This can affect the language of the labels and descriptions returned.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PropertyGroup" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.owners.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.schemas.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.schemas.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.schemas.services.read" ] + }, { + "oauth2" : [ "crm.schemas.line_items.read" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.read" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "cpq.price_books.write" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.read" ] + }, { + "oauth2" : [ "crm.schemas.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.schemas.orders.read" ] + }, { + "oauth2" : [ "crm.schemas.emails.read" ] + }, { + "oauth2" : [ "crm.schemas.deals.read" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.notes.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.read" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.schemas.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.schemas.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.marketing_events.read" ] + }, { + "oauth2" : [ "crm.pipelines.orders.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "automation" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.read" ] + }, { + "oauth2" : [ "cpq.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.schemas.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.schemas.courses.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.pipelines.approval.read" ] + }, { + "oauth2" : [ "workflows.write" ] + }, { + "oauth2" : [ "crm.objects.marketing_events.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.read" ] + }, { + "oauth2" : [ "workflows.read" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.read" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "delete" : { + "tags" : [ "Basic" ], + "summary" : "Archive a property group", + "description" : "Move a property group identified by {groupName} to the recycling bin.", + "operationId" : "delete-/crm/properties/2026-03/{objectType}/groups/{groupName}_/crm/properties/2025-09/{objectType}/groups/{groupName}", + "parameters" : [ { + "name" : "groupName", + "in" : "path", + "description" : "The unique name of the property group to be deleted.", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "The type of object for which the property group is defined, such as contacts, companies, or deals.", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.invoices.write" ] + }, { + "oauth2" : [ "crm.schemas.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.write" ] + }, { + "oauth2" : [ "crm.schemas.courses.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.appointments.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.emails.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.write" ] + }, { + "oauth2" : [ "crm.pipelines.orders.write" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.schemas.services.write" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.notes.write" ] + }, { + "oauth2" : [ "crm.schemas.contracts.write" ] + }, { + "oauth2" : [ "crm.schemas.meetings.write" ] + }, { + "oauth2" : [ "crm.schemas.deals.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.write" ] + }, { + "oauth2" : [ "crm.schemas.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + } ] + }, + "patch" : { + "tags" : [ "Basic" ], + "summary" : "Update a property group", + "description" : "Perform a partial update of a property group identified by {groupName}. Provided fields will be overwritten.", + "operationId" : "patch-/crm/properties/2026-03/{objectType}/groups/{groupName}_/crm/properties/2025-09/{objectType}/groups/{groupName}", + "parameters" : [ { + "name" : "groupName", + "in" : "path", + "description" : "The name of the property group to update.", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "The type of object for which the property group is being updated, such as contacts, companies, or deals.", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PropertyGroupUpdate" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PropertyGroup" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.invoices.write" ] + }, { + "oauth2" : [ "crm.schemas.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.write" ] + }, { + "oauth2" : [ "crm.schemas.courses.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.appointments.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.emails.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.write" ] + }, { + "oauth2" : [ "crm.pipelines.orders.write" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.schemas.services.write" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.notes.write" ] + }, { + "oauth2" : [ "crm.schemas.contracts.write" ] + }, { + "oauth2" : [ "crm.schemas.meetings.write" ] + }, { + "oauth2" : [ "crm.schemas.deals.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.write" ] + }, { + "oauth2" : [ "crm.schemas.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/properties/2026-03/{objectType}/{propertyName}" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Read a property", + "description" : "Read a property identified by {propertyName}.", + "operationId" : "get-/crm/properties/2026-03/{objectType}/{propertyName}_/crm/properties/2025-09/{objectType}/{propertyName}", + "parameters" : [ { + "name" : "objectType", + "in" : "path", + "description" : "The type of object the property belongs to, such as 'contacts' or 'deals'.", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "propertyName", + "in" : "path", + "description" : "The name of the property to retrieve.", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "dataSensitivity", + "in" : "query", + "description" : "The level of data sensitivity to filter properties by. Valid values are 'non_sensitive', 'sensitive', and 'highly_sensitive'. Defaults to 'non_sensitive'.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "non_sensitive", + "enum" : [ "highly_sensitive", "non_sensitive", "sensitive" ] + } + }, { + "name" : "locale", + "in" : "query", + "description" : "The locale to use for property labels and descriptions.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "properties", + "in" : "query", + "description" : "A comma-separated list of property names to include in the response.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Property" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.owners.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.schemas.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.schemas.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.schemas.services.read" ] + }, { + "oauth2" : [ "crm.schemas.line_items.read" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.read" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "cpq.price_books.write" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.read" ] + }, { + "oauth2" : [ "crm.schemas.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.schemas.orders.read" ] + }, { + "oauth2" : [ "crm.schemas.emails.read" ] + }, { + "oauth2" : [ "crm.schemas.deals.read" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.notes.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.read" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.schemas.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.schemas.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.marketing_events.read" ] + }, { + "oauth2" : [ "crm.pipelines.orders.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "automation" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.read" ] + }, { + "oauth2" : [ "cpq.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.schemas.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.schemas.courses.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.pipelines.approval.read" ] + }, { + "oauth2" : [ "workflows.write" ] + }, { + "oauth2" : [ "crm.objects.marketing_events.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.read" ] + }, { + "oauth2" : [ "workflows.read" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.read" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "delete" : { + "tags" : [ "Basic" ], + "summary" : "Archive a property", + "description" : "Move a property identified by {propertyName} to the recycling bin.", + "operationId" : "delete-/crm/properties/2026-03/{objectType}/{propertyName}_/crm/properties/2025-09/{objectType}/{propertyName}", + "parameters" : [ { + "name" : "objectType", + "in" : "path", + "description" : "The type of CRM object that the property belongs to, such as contacts, companies, or deals.", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "propertyName", + "in" : "path", + "description" : "The unique name of the property to delete.", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.invoices.write" ] + }, { + "oauth2" : [ "crm.schemas.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.write" ] + }, { + "oauth2" : [ "crm.schemas.courses.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.appointments.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.emails.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.write" ] + }, { + "oauth2" : [ "crm.pipelines.orders.write" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.schemas.services.write" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.notes.write" ] + }, { + "oauth2" : [ "crm.schemas.contracts.write" ] + }, { + "oauth2" : [ "crm.schemas.meetings.write" ] + }, { + "oauth2" : [ "crm.schemas.deals.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.write" ] + }, { + "oauth2" : [ "crm.schemas.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + } ] + }, + "patch" : { + "tags" : [ "Basic" ], + "summary" : "Update a property", + "description" : "Perform a partial update of a property identified by { propertyName }. Provided fields will be overwritten.", + "operationId" : "patch-/crm/properties/2026-03/{objectType}/{propertyName}_/crm/properties/2025-09/{objectType}/{propertyName}", + "parameters" : [ { + "name" : "objectType", + "in" : "path", + "description" : "The type of object for which the property is being updated, such as contacts, companies, or deals.", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "propertyName", + "in" : "path", + "description" : "The unique name of the property to update.", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PropertyUpdate" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Property" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.schemas.quotes.write" ] + }, { + "oauth2" : [ "crm.schemas.invoices.write" ] + }, { + "oauth2" : [ "crm.schemas.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.commercepayments.write" ] + }, { + "oauth2" : [ "crm.schemas.courses.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.schemas.appointments.write" ] + }, { + "oauth2" : [ "crm.schemas.contacts.write" ] + }, { + "oauth2" : [ "crm.schemas.tasks.write" ] + }, { + "oauth2" : [ "crm.schemas.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "crm.schemas.companies.write" ] + }, { + "oauth2" : [ "crm.schemas.subscriptions.write" ] + }, { + "oauth2" : [ "crm.schemas.emails.write" ] + }, { + "oauth2" : [ "crm.schemas.custom.write" ] + }, { + "oauth2" : [ "crm.schemas.listings.write" ] + }, { + "oauth2" : [ "crm.pipelines.orders.write" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.schemas.services.write" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.schemas.notes.write" ] + }, { + "oauth2" : [ "crm.schemas.contracts.write" ] + }, { + "oauth2" : [ "crm.schemas.meetings.write" ] + }, { + "oauth2" : [ "crm.schemas.deals.write" ] + }, { + "oauth2" : [ "crm.schemas.projects.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.schemas.calls.write" ] + }, { + "oauth2" : [ "crm.schemas.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + } + }, + "components" : { + "schemas" : { + "BatchInputPropertyCreate" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of PropertyCreate objects, each representing a property to be created. This field is required.", + "items" : { + "$ref" : "#/components/schemas/PropertyCreate" + } + } + } + }, + "BatchInputPropertyName" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of property names to be processed in the batch operation. Each item in the array is a reference to a PropertyName object.", + "items" : { + "$ref" : "#/components/schemas/PropertyName" + } + } + } + }, + "BatchReadInputPropertyName" : { + "required" : [ "archived", "dataSensitivity", "inputs" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Specifies whether the property is archived." + }, + "dataSensitivity" : { + "type" : "string", + "description" : "Indicates the sensitivity level of the data, such as 'non_sensitive', 'sensitive', or 'highly_sensitive'.", + "enum" : [ "highly_sensitive", "non_sensitive", "sensitive" ] + }, + "inputs" : { + "type" : "array", + "description" : "An array of property names to be included in the batch read operation. Each item in the array is a reference to a PropertyName object.", + "items" : { + "$ref" : "#/components/schemas/PropertyName" + } + } + } + }, + "BatchResponseProperty" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp indicating when the batch operation was completed.", + "format" : "date-time" + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A collection of URLs linking to documentation or resources related to the batch operation." + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp indicating when the batch operation was requested.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of Property objects representing the results of the batch operation.", + "items" : { + "$ref" : "#/components/schemas/Property" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp indicating when the batch operation began processing.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The current status of the batch operation, with possible values being CANCELED, COMPLETE, PENDING, or PROCESSING.", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + } + }, + "BatchResponsePropertyWithErrors" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The date and time when the batch operation was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "description" : "An array of errors encountered during the batch operation, each represented by a StandardError object.", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to their associated URIs, providing additional information or actions related to the batch operation." + }, + "numErrors" : { + "type" : "integer", + "description" : "The number of errors encountered during the batch operation.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The date and time when the batch operation was requested, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of properties that were processed in the batch operation.", + "items" : { + "$ref" : "#/components/schemas/Property" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The date and time when the batch operation started, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'.", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + } + }, + "CollectionResponsePropertyGroupNoPaging" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "results" : { + "type" : "array", + "description" : "An array of property groups, where each group is represented by a PropertyGroup object.", + "items" : { + "$ref" : "#/components/schemas/PropertyGroup" + } + } + } + }, + "CollectionResponsePropertyNoPaging" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "results" : { + "type" : "array", + "description" : "An array of Property objects, each representing a specific property associated with the object type. This array contains the details of each property such as name, label, type, and other metadata.", + "items" : { + "$ref" : "#/components/schemas/Property" + } + } + } + }, + "Error" : { + "required" : [ "category", "correlationId", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The error category" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}" + }, + "correlationId" : { + "type" : "string", + "description" : "A unique identifier for the request. Include this value with any error reports or support tickets", + "format" : "uuid", + "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf" + }, + "errors" : { + "type" : "array", + "description" : "further information about the error", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps" + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate", + "example" : "An error occurred" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered.", + "example" : { + "message" : "Invalid input (details will vary based on the error)", + "correlationId" : "aeb5f871-7f07-4993-9211-075dc63e7cbf", + "category" : "VALIDATION_ERROR", + "links" : { + "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base" + } + } + }, + "ErrorDetail" : { + "required" : [ "message" ], + "type" : "object", + "properties" : { + "code" : { + "type" : "string", + "description" : "The status code associated with the error detail" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{missingScopes=[scope1, scope2]}" + }, + "in" : { + "type" : "string", + "description" : "The name of the field or parameter in which the error was found." + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response." + }, + "Option" : { + "required" : [ "hidden", "label", "value" ], + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "A description of the option." + }, + "displayOrder" : { + "type" : "integer", + "description" : "Options are displayed in order starting with the lowest positive integer value. Values of -1 will cause the option to be displayed after any positive values.", + "format" : "int32" + }, + "hidden" : { + "type" : "boolean", + "description" : "Hidden options will not be displayed in HubSpot." + }, + "label" : { + "type" : "string", + "description" : "A human-readable option label that will be shown in HubSpot." + }, + "value" : { + "type" : "string", + "description" : "The internal value of the option, which must be used when setting the property value through the API." + } + }, + "description" : "A HubSpot property option" + }, + "OptionInput" : { + "required" : [ "displayOrder", "hidden", "label", "value" ], + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "A description of the option." + }, + "displayOrder" : { + "type" : "integer", + "description" : "Options are shown in order starting with the lowest positive integer value. Values of -1 will cause the option to be displayed after any positive values.", + "format" : "int32" + }, + "hidden" : { + "type" : "boolean", + "description" : "Hidden options won't be shown in HubSpot." + }, + "label" : { + "type" : "string", + "description" : "A human-readable option label that will be shown in HubSpot." + }, + "value" : { + "type" : "string", + "description" : "The internal value of the option, which must be used when setting the property value through the API." + } + } + }, + "Property" : { + "required" : [ "description", "fieldType", "groupName", "label", "name", "options", "type" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether or not the property is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "When the property was archived.", + "format" : "date-time" + }, + "calculated" : { + "type" : "boolean", + "description" : "For default properties, true indicates that the property is calculated by a HubSpot process. It has no effect for custom properties." + }, + "calculationFormula" : { + "type" : "string", + "description" : "Represents a formula that is used to compute a calculated property." + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the property was created, in ISO 8601 format.", + "format" : "date-time" + }, + "createdUserId" : { + "type" : "string", + "description" : "The internal user ID of the user who created the property in HubSpot. This field may not exist if the property was created outside of HubSpot." + }, + "currencyPropertyName" : { + "type" : "string", + "description" : "The name of the currency property associated with this property, if applicable." + }, + "dataSensitivity" : { + "type" : "string", + "description" : "The sensitivity level of the data. Valid values include 'non_sensitive', 'sensitive', and 'highly_sensitive'.", + "enum" : [ "highly_sensitive", "non_sensitive", "sensitive" ] + }, + "dateDisplayHint" : { + "type" : "string", + "description" : "Indicates how date values should be displayed, with options such as 'absolute', 'absolute_with_relative', 'time_since', or 'time_until'.", + "enum" : [ "absolute", "absolute_with_relative", "time_since", "time_until" ] + }, + "description" : { + "type" : "string", + "description" : "A description of the property that will be shown as help text in HubSpot." + }, + "displayOrder" : { + "type" : "integer", + "description" : "Properties are shown in order, starting with the lowest positive integer value.", + "format" : "int32" + }, + "externalOptions" : { + "type" : "boolean", + "description" : "For default properties, true indicates that the options are stored externally to the property settings." + }, + "fieldType" : { + "type" : "string", + "description" : "Controls how the property appears in HubSpot." + }, + "formField" : { + "type" : "boolean", + "description" : "Whether or not the property can be used in a HubSpot form." + }, + "groupName" : { + "type" : "string", + "description" : "The name of the property group the property belongs to." + }, + "hasUniqueValue" : { + "type" : "boolean", + "description" : "Whether or not the property's value must be unique. Once set, this can't be changed." + }, + "hidden" : { + "type" : "boolean", + "description" : "Whether or not the property will be hidden from the HubSpot UI. It's recommended this be set to false for custom properties.", + "example" : false + }, + "hubspotDefined" : { + "type" : "boolean", + "description" : "This will be true for default object properties built into HubSpot." + }, + "label" : { + "type" : "string", + "description" : "A human-readable property label that will be shown in HubSpot." + }, + "modificationMetadata" : { + "$ref" : "#/components/schemas/PropertyModificationMetadata" + }, + "name" : { + "type" : "string", + "description" : "The internal property name, which must be used when referencing the property via the API." + }, + "numberDisplayHint" : { + "type" : "string", + "description" : "A hint for displaying number properties. Valid values include 'unformatted', 'formatted', 'currency', 'percentage', 'duration', and 'probability'.", + "enum" : [ "currency", "duration", "formatted", "percentage", "probability", "unformatted" ] + }, + "options" : { + "type" : "array", + "description" : "A list of valid options for the property. This field is required for enumerated properties, but will be empty for other property types.", + "items" : { + "$ref" : "#/components/schemas/Option" + } + }, + "referencedObjectType" : { + "type" : "string", + "description" : "If this property is related to other object(s), they'll be listed here." + }, + "sensitiveDataCategories" : { + "type" : "array", + "description" : "An array of categories indicating the sensitivity of the data contained in the property.", + "items" : { + "type" : "string" + } + }, + "showCurrencySymbol" : { + "type" : "boolean", + "description" : "Whether or not the property will display the currency symbol set in the account settings." + }, + "textDisplayHint" : { + "type" : "string", + "description" : "A hint for displaying text properties. Valid values include 'unformatted_single_line', 'multi_line', 'email', 'phone_number', 'domain_name', 'ip_address', 'physical_address', and 'postal_code'.", + "enum" : [ "domain_name", "email", "ip_address", "multi_line", "phone_number", "physical_address", "postal_code", "unformatted_single_line" ] + }, + "type" : { + "type" : "string", + "description" : "The property data type." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the property was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "updatedUserId" : { + "type" : "string", + "description" : "The internal user ID of the user who updated the property in HubSpot. This field may not exist if the property was updated outside of HubSpot." + } + }, + "description" : "A HubSpot property" + }, + "PropertyCreate" : { + "required" : [ "fieldType", "groupName", "label", "name", "type" ], + "type" : "object", + "properties" : { + "calculationFormula" : { + "type" : "string", + "description" : "Represents a formula that is used to compute a calculated property." + }, + "currencyPropertyName" : { + "type" : "string", + "description" : "A string representing the name of the currency property." + }, + "dataSensitivity" : { + "type" : "string", + "description" : "Indicates the sensitivity level of the property, with options: highly_sensitive, non_sensitive, or sensitive.", + "enum" : [ "highly_sensitive", "non_sensitive", "sensitive" ] + }, + "description" : { + "type" : "string", + "description" : "A description of the property that will be shown as help text in HubSpot." + }, + "displayOrder" : { + "type" : "integer", + "description" : "Properties are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property to be displayed after any positive values.", + "format" : "int32" + }, + "externalOptions" : { + "type" : "boolean", + "description" : "Applicable only for 'enumeration' type properties. Should be set to true in conjunction with a 'referencedObjectType' of 'OWNER'. Otherwise false." + }, + "fieldType" : { + "type" : "string", + "description" : "Controls how the property appears in HubSpot.", + "enum" : [ "booleancheckbox", "calculation_equation", "checkbox", "date", "file", "html", "number", "phonenumber", "radio", "select", "text", "textarea" ] + }, + "formField" : { + "type" : "boolean", + "description" : "Whether or not the property can be used in a HubSpot form." + }, + "groupName" : { + "type" : "string", + "description" : "The name of the property group the property belongs to." + }, + "hasUniqueValue" : { + "type" : "boolean", + "description" : "Whether or not the property's value must be unique. Once set, this can't be changed." + }, + "hidden" : { + "type" : "boolean", + "description" : "If true, the property won't be visible and can't be used in HubSpot." + }, + "label" : { + "type" : "string", + "description" : "A human-readable property label that will be shown in HubSpot." + }, + "name" : { + "type" : "string", + "description" : "The internal property name, which must be used when referencing the property via the API." + }, + "numberDisplayHint" : { + "type" : "string", + "description" : "A string providing a hint on how to display numbers. Valid values include 'unformatted', 'formatted', 'currency', 'percentage', 'duration', 'probability'.", + "enum" : [ "currency", "duration", "formatted", "percentage", "probability", "unformatted" ] + }, + "options" : { + "type" : "array", + "description" : "A list of valid options for the property. This field is required for enumerated properties.", + "items" : { + "$ref" : "#/components/schemas/OptionInput" + } + }, + "referencedObjectType" : { + "type" : "string", + "description" : "Should be set to 'OWNER' when 'externalOptions' is true, which causes the property to dynamically pull option values from the current HubSpot users." + }, + "showCurrencySymbol" : { + "type" : "boolean", + "description" : "A boolean indicating whether to show the currency symbol for currency fields." + }, + "textDisplayHint" : { + "type" : "string", + "description" : "A string providing a hint on how to display text. Valid values include 'unformatted_single_line', 'multi_line', 'email', 'phone_number', 'domain_name', 'ip_address', 'physical_address', 'postal_code'.", + "enum" : [ "domain_name", "email", "ip_address", "multi_line", "phone_number", "physical_address", "postal_code", "unformatted_single_line" ] + }, + "type" : { + "type" : "string", + "description" : "The data type of the property.", + "enum" : [ "bool", "date", "datetime", "enumeration", "number", "phone_number", "string" ] + } + } + }, + "PropertyGroup" : { + "required" : [ "archived", "label", "name" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Indicates whether the property group is archived." + }, + "displayOrder" : { + "type" : "integer", + "description" : "Property groups are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property group to be displayed after any positive values.", + "format" : "int32" + }, + "label" : { + "type" : "string", + "description" : "A human-readable label that will be shown in HubSpot." + }, + "name" : { + "type" : "string", + "description" : "The internal property group name, which must be used when referencing the property group via the API." + } + } + }, + "PropertyGroupCreate" : { + "required" : [ "label", "name" ], + "type" : "object", + "properties" : { + "displayOrder" : { + "type" : "integer", + "description" : "Property groups are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property group to be displayed after any positive values.", + "format" : "int32" + }, + "label" : { + "type" : "string", + "description" : "A human-readable label that will be shown in HubSpot." + }, + "name" : { + "type" : "string", + "description" : "The internal property group name, which must be used when referencing the property group via the API." + } + } + }, + "PropertyGroupUpdate" : { + "type" : "object", + "properties" : { + "displayOrder" : { + "type" : "integer", + "description" : "Property groups are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property group to be displayed after any positive values.", + "format" : "int32" + }, + "label" : { + "type" : "string", + "description" : "A human-readable label that will be shown in HubSpot." + } + } + }, + "PropertyModificationMetadata" : { + "required" : [ "archivable", "readOnlyDefinition", "readOnlyValue" ], + "type" : "object", + "properties" : { + "archivable" : { + "type" : "boolean", + "description" : "Specifies whether the property can be archived." + }, + "readOnlyDefinition" : { + "type" : "boolean", + "description" : "Indicates whether the property's definition is read-only and cannot be modified." + }, + "readOnlyOptions" : { + "type" : "boolean", + "description" : "Indicates whether the property's options are read-only and cannot be modified." + }, + "readOnlyValue" : { + "type" : "boolean", + "description" : "Indicates whether the property's value is read-only and cannot be modified." + } + } + }, + "PropertyName" : { + "required" : [ "name" ], + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the property to read or modify." + } + } + }, + "PropertyUpdate" : { + "type" : "object", + "properties" : { + "calculationFormula" : { + "type" : "string", + "description" : "Represents a formula that is used to compute a calculated property." + }, + "currencyPropertyName" : { + "type" : "string", + "description" : "A string specifying the name of the property that holds the currency information, applicable when showCurrencySymbol is true." + }, + "description" : { + "type" : "string", + "description" : "A description of the property that will be shown as help text in HubSpot." + }, + "displayOrder" : { + "type" : "integer", + "description" : "Properties are displayed in order starting with the lowest positive integer value. Values of -1 will cause the Property to be displayed after any positive values.", + "format" : "int32" + }, + "fieldType" : { + "type" : "string", + "description" : "Controls how the property appears in HubSpot.", + "enum" : [ "booleancheckbox", "calculation_equation", "checkbox", "date", "file", "html", "number", "phonenumber", "radio", "select", "text", "textarea" ] + }, + "formField" : { + "type" : "boolean", + "description" : "Whether or not the property can be used in a HubSpot form." + }, + "groupName" : { + "type" : "string", + "description" : "The name of the property group the property belongs to." + }, + "hidden" : { + "type" : "boolean", + "description" : "If true, the property won't be visible and can't be used in HubSpot." + }, + "label" : { + "type" : "string", + "description" : "A human-readable property label that will be shown in HubSpot." + }, + "numberDisplayHint" : { + "type" : "string", + "description" : "A string providing a hint for displaying number values. Valid values include 'unformatted', 'formatted', 'currency', 'percentage', 'duration', and 'probability'.", + "enum" : [ "currency", "duration", "formatted", "percentage", "probability", "unformatted" ] + }, + "options" : { + "type" : "array", + "description" : "A list of valid options for the property.", + "items" : { + "$ref" : "#/components/schemas/OptionInput" + } + }, + "showCurrencySymbol" : { + "type" : "boolean", + "description" : "A boolean indicating whether to display a currency symbol for number fields formatted as currency." + }, + "textDisplayHint" : { + "type" : "string", + "description" : "A string providing a hint for displaying text values. Valid values include 'unformatted_single_line', 'multi_line', 'email', 'phone_number', 'domain_name', 'ip_address', 'physical_address', and 'postal_code'.", + "enum" : [ "domain_name", "email", "ip_address", "multi_line", "phone_number", "physical_address", "postal_code", "unformatted_single_line" ] + }, + "type" : { + "type" : "string", + "description" : "The data type of the property.", + "enum" : [ "bool", "date", "datetime", "enumeration", "number", "phone_number", "string" ] + } + } + }, + "StandardError" : { + "required" : [ "category", "context", "errors", "links", "message", "status" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The main category of the error." + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Additional context-specific information related to the error." + }, + "errors" : { + "type" : "array", + "description" : "The detailed error objects.", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "id" : { + "type" : "string", + "description" : "A unique ID for the error instance." + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "URLs linking to documentation or resources associated with the error." + }, + "message" : { + "type" : "string", + "description" : "A human-readable string describing the error and possible remediation steps." + }, + "status" : { + "type" : "string", + "description" : "The HTTP status code associated with the error." + }, + "subCategory" : { + "type" : "object", + "properties" : { }, + "description" : "A more specific error category within each main category." + } + }, + "description" : "Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request." + } + }, + "responses" : { + "Error" : { + "description" : "An error occurred.", + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + } + } + } + }, + "securitySchemes" : { + "developer_hapikey" : { + "type" : "apiKey", + "name" : "hapikey", + "in" : "query" + }, + "oauth2" : { + "type" : "oauth2", + "flows" : { + "authorizationCode" : { + "authorizationUrl" : "https://app.hubspot.com/oauth/authorize", + "tokenUrl" : "https://api.hubapi.com/oauth/v1/token", + "scopes" : { + "automation" : "", + "cpq.price_books.read" : "", + "cpq.price_books.write" : "", + "cpq.quotes.read" : "", + "cpq.quotes.write" : "", + "crm.objects.appointments.read" : "", + "crm.objects.appointments.sensitive.read.v2" : "", + "crm.objects.appointments.sensitive.write.v2" : "", + "crm.objects.appointments.write" : "", + "crm.objects.calls.read" : "", + "crm.objects.calls.write" : "", + "crm.objects.carts.read" : "", + "crm.objects.carts.write" : "", + "crm.objects.commercepayments.write" : "", + "crm.objects.companies.highly_sensitive.read.v2" : "", + "crm.objects.companies.highly_sensitive.write.v2" : "", + "crm.objects.companies.read" : "", + "crm.objects.companies.sensitive.read.v2" : "", + "crm.objects.companies.sensitive.write.v2" : "", + "crm.objects.companies.write" : "", + "crm.objects.contacts.highly_sensitive.read.v2" : "", + "crm.objects.contacts.highly_sensitive.write.v2" : "", + "crm.objects.contacts.read" : "", + "crm.objects.contacts.sensitive.read.v2" : "", + "crm.objects.contacts.sensitive.write.v2" : "", + "crm.objects.contacts.write" : "", + "crm.objects.contracts.read" : "", + "crm.objects.courses.read" : "", + "crm.objects.courses.write" : "", + "crm.objects.custom.highly_sensitive.read.v2" : "", + "crm.objects.custom.highly_sensitive.write.v2" : "", + "crm.objects.custom.read" : "", + "crm.objects.custom.sensitive.read.v2" : "", + "crm.objects.custom.sensitive.write.v2" : "", + "crm.objects.custom.write" : "", + "crm.objects.deals.highly_sensitive.read.v2" : "", + "crm.objects.deals.highly_sensitive.write.v2" : "", + "crm.objects.deals.read" : "", + "crm.objects.deals.sensitive.read.v2" : "", + "crm.objects.deals.sensitive.write.v2" : "", + "crm.objects.deals.write" : "", + "crm.objects.emails.read" : "", + "crm.objects.emails.write" : "", + "crm.objects.feedback_submissions.read" : "", + "crm.objects.forecasts.read" : "", + "crm.objects.goals.read" : "", + "crm.objects.goals.write" : "", + "crm.objects.invoices.read" : "", + "crm.objects.invoices.write" : "", + "crm.objects.leads.read" : "", + "crm.objects.leads.write" : "", + "crm.objects.line_items.read" : "", + "crm.objects.line_items.write" : "", + "crm.objects.listings.read" : "", + "crm.objects.listings.write" : "", + "crm.objects.marketing_events.read" : "", + "crm.objects.marketing_events.write" : "", + "crm.objects.meetings.read" : "", + "crm.objects.meetings.write" : "", + "crm.objects.notes.read" : "", + "crm.objects.notes.write" : "", + "crm.objects.orders.read" : "", + "crm.objects.orders.write" : "", + "crm.objects.owners.read" : "", + "crm.objects.products.write" : "", + "crm.objects.projects.highly_sensitive.read" : "", + "crm.objects.projects.highly_sensitive.write" : "", + "crm.objects.projects.read" : "", + "crm.objects.projects.sensitive.read" : "", + "crm.objects.projects.sensitive.write" : "", + "crm.objects.projects.write" : "", + "crm.objects.quotes.read" : "", + "crm.objects.quotes.write" : "", + "crm.objects.services.read" : "", + "crm.objects.services.write" : "", + "crm.objects.subscriptions.read" : "", + "crm.objects.subscriptions.write" : "", + "crm.objects.tasks.read" : "", + "crm.objects.tasks.write" : "", + "crm.objects.tickets.highly_sensitive.read" : "", + "crm.objects.tickets.highly_sensitive.write" : "", + "crm.objects.tickets.read" : "", + "crm.objects.tickets.sensitive.read" : "", + "crm.objects.tickets.sensitive.write" : "", + "crm.objects.tickets.write" : "", + "crm.objects.users.read" : "", + "crm.objects.users.write" : "", + "crm.pipelines.approval.read" : "", + "crm.pipelines.orders.read" : "", + "crm.pipelines.orders.write" : "", + "crm.schemas.appointments.read" : "", + "crm.schemas.appointments.write" : "", + "crm.schemas.calls.read" : "", + "crm.schemas.calls.write" : "", + "crm.schemas.carts.read" : "", + "crm.schemas.carts.write" : "", + "crm.schemas.commercepayments.read" : "", + "crm.schemas.commercepayments.write" : "", + "crm.schemas.companies.read" : "", + "crm.schemas.companies.write" : "", + "crm.schemas.contacts.read" : "", + "crm.schemas.contacts.write" : "", + "crm.schemas.contracts.read" : "", + "crm.schemas.contracts.write" : "", + "crm.schemas.courses.read" : "", + "crm.schemas.courses.write" : "", + "crm.schemas.custom.read" : "", + "crm.schemas.custom.write" : "", + "crm.schemas.deals.read" : "", + "crm.schemas.deals.write" : "", + "crm.schemas.emails.read" : "", + "crm.schemas.emails.write" : "", + "crm.schemas.forecasts.read" : "", + "crm.schemas.invoices.read" : "", + "crm.schemas.invoices.write" : "", + "crm.schemas.line_items.read" : "", + "crm.schemas.listings.read" : "", + "crm.schemas.listings.write" : "", + "crm.schemas.meetings.read" : "", + "crm.schemas.meetings.write" : "", + "crm.schemas.notes.read" : "", + "crm.schemas.notes.write" : "", + "crm.schemas.orders.read" : "", + "crm.schemas.orders.write" : "", + "crm.schemas.projects.read" : "", + "crm.schemas.projects.write" : "", + "crm.schemas.quotes.read" : "", + "crm.schemas.quotes.write" : "", + "crm.schemas.services.read" : "", + "crm.schemas.services.write" : "", + "crm.schemas.subscriptions.read" : "", + "crm.schemas.subscriptions.write" : "", + "crm.schemas.tasks.read" : "", + "crm.schemas.tasks.write" : "", + "crm.schemas.tickets.read" : "", + "crm.schemas.tickets.write" : "", + "e-commerce" : "", + "media_bridge.read" : "", + "tickets.highly_sensitive.v2" : "", + "tickets.sensitive.v2" : "", + "workflows.read" : "", + "workflows.write" : "" + } + } + }, + "x-hubspot-app-availability" : { + "automation" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "cpq.price_books.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "cpq.price_books.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "cpq.quotes.read" : { + "portal" : [ "public" ], + "user" : [ "public" ], + "developer" : false + }, + "cpq.quotes.write" : { + "portal" : [ "public" ], + "user" : [ "public" ], + "developer" : false + }, + "crm.objects.appointments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.commercepayments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.companies.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.contacts.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contracts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.custom.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.feedback_submissions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.forecasts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.marketing_events.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.marketing_events.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.owners.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.products.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.pipelines.approval.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.pipelines.orders.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.pipelines.orders.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.appointments.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.appointments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.calls.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.calls.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.carts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.carts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.commercepayments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.commercepayments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.companies.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.schemas.companies.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.contacts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.schemas.contacts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.contracts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.contracts.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.courses.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.courses.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.custom.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.schemas.custom.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.schemas.deals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.schemas.deals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.emails.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.emails.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.forecasts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.invoices.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.invoices.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.line_items.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.listings.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.listings.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.meetings.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.meetings.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.notes.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.notes.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.orders.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.orders.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.projects.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.projects.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.quotes.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.quotes.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.subscriptions.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.subscriptions.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.tasks.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.tasks.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.tickets.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.schemas.tickets.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "e-commerce" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "media_bridge.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "tickets.highly_sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "tickets.sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "workflows.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "workflows.write" : { + "user" : [ "public", "private" ], + "developer" : false + } + } + } + } + }, + "x-hubspot-available-client-libraries" : [ "Node", "Python", "Ruby", "PHP" ], + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + } +} \ No newline at end of file diff --git a/spec/hubspot/provenance.json b/spec/hubspot/provenance.json index 0663b8d..75e128d 100644 --- a/spec/hubspot/provenance.json +++ b/spec/hubspot/provenance.json @@ -1,11 +1,95 @@ { "sources": [ { - "name": "comments", - "url": "https://comments.example.invalid/openapi.json", - "file": "openapi.json", - "sha256": "ceebdace963dfeff04113bc3b4293ccac41b3d27249ffa4fba933e4852c36960" + "name": "contacts", + "url": "https://api.hubspot.com/public/api/spec/v2/specs/release/75232/version/2026-03", + "file": "contacts.json", + "sha256": "0bfc51ecbf87c0d90bd13663db9189b665c06272b717c677966b909e796bc05c" + }, + { + "name": "companies", + "url": "https://api.hubspot.com/public/api/spec/v2/specs/release/75244/version/2026-03", + "file": "companies.json", + "sha256": "a950ce04d70c4b5cc7a3e0a1465956d2be6841a1d838670b49014e1bfc56632b" + }, + { + "name": "deals", + "url": "https://api.hubspot.com/public/api/spec/v2/specs/release/75246/version/2026-03", + "file": "deals.json", + "sha256": "ad24485bf240618eeb7723d3827af945608c8afbccf0113a15414095855afbf7" + }, + { + "name": "tickets", + "url": "https://api.hubspot.com/public/api/spec/v2/specs/release/75274/version/2026-03", + "file": "tickets.json", + "sha256": "25f8c3f76ebaeb9170d4f4aa3c66739e71cefdbaa6cc16c53ffaa1af97326bb3" + }, + { + "name": "leads", + "url": "https://api.hubspot.com/public/api/spec/v2/specs/release/75224/version/2026-03", + "file": "leads.json", + "sha256": "a76bbd98ab2145c2875e8664365397ec6bf05e1801c8abefec453b87cfb28e83" + }, + { + "name": "notes", + "url": "https://api.hubspot.com/public/api/spec/v2/specs/release/75313/version/2026-03", + "file": "notes.json", + "sha256": "678f9711e004d4164b7fe83b035ff4c698f94871f1e48cb9b682eb05ac957586" + }, + { + "name": "calls", + "url": "https://api.hubspot.com/public/api/spec/v2/specs/release/75288/version/2026-03", + "file": "calls.json", + "sha256": "4f01312dcec9d43ba31633a5bf8e20174ea454662c2b038fbc918ef6e4b67350" + }, + { + "name": "emails", + "url": "https://api.hubspot.com/public/api/spec/v2/specs/release/75305/version/2026-03", + "file": "emails.json", + "sha256": "d1cdd3f6863af52ff528476e3f93bf4fdc46e8c44d6cc4a08e1054a531726bbd" + }, + { + "name": "meetings", + "url": "https://api.hubspot.com/public/api/spec/v2/specs/release/75236/version/2026-03", + "file": "meetings.json", + "sha256": "2dcac97ab96a874721c607c9e33f924e074285014e1ba9b62e4aa36c3827ccca" + }, + { + "name": "tasks", + "url": "https://api.hubspot.com/public/api/spec/v2/specs/release/75262/version/2026-03", + "file": "tasks.json", + "sha256": "671fde0b9bff4298f152139fab74b13067515154e5a3229526b1fd3a6935c200" + }, + { + "name": "crm-owners", + "url": "https://api.hubspot.com/public/api/spec/v2/specs/release/75347/version/2026-03", + "file": "crm-owners.json", + "sha256": "4acbb13514cdf35a9960c0fa41ecfa1e870003e9e2115c0b470f1237aa7bbcaf" + }, + { + "name": "pipelines", + "url": "https://api.hubspot.com/public/api/spec/v2/specs/release/75321/version/2026-03", + "file": "pipelines.json", + "sha256": "646c9d395c8b4a5f118fe6803ba515c0494ff1e426911f9397c69a09329cca33" + }, + { + "name": "properties", + "url": "https://api.hubspot.com/public/api/spec/v2/specs/release/75280/version/2026-03", + "file": "properties.json", + "sha256": "2aa81bbd7f581e5081be0128b79363cdf02ed4468d0b2ef39de746ff83d3188f" + }, + { + "name": "associations", + "url": "https://api.hubspot.com/public/api/spec/v2/specs/release/75258/version/2026-03", + "file": "associations.json", + "sha256": "810d1a3d5731e025bdf8f7161e5c3dd2fba8bb1f51f2bd6499bf73d94a30f29f" + }, + { + "name": "account-info", + "url": "https://api.hubspot.com/public/api/spec/v2/specs/release/75551/version/2026-03", + "file": "account-info.json", + "sha256": "f73cdbee0a56739f094b6893dd69e9c7b0307ce874c2c8918a17250a21fbd071" } ], - "retrieved_at": "2026-11-16T00:00:00.000Z" + "retrieved_at": "2026-11-17T02:06:56.256Z" } diff --git a/spec/hubspot/tasks.json b/spec/hubspot/tasks.json new file mode 100644 index 0000000..e4f9314 --- /dev/null +++ b/spec/hubspot/tasks.json @@ -0,0 +1,3106 @@ +{ + "openapi" : "3.0.1", + "info" : { + "title" : "Tasks", + "description" : "Basepom for all HubSpot Projects", + "version" : "2026-03", + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + }, + "x-hubspot-api-use-case" : "If you're using a third-party service for project management, you can create and manage any tasks associated with your CRM records by logging them in HubSpot.", + "x-hubspot-introduction" : "Use the tasks API to associate tasks with your CRM records. You can assign tasks to specific users in your account, keep track of their status, and organize them using different priorities and types." + }, + "servers" : [ { + "url" : "https://api.hubapi.com" + } ], + "tags" : [ { + "name" : "Basic" + }, { + "name" : "Batch" + }, { + "name" : "Search" + } ], + "paths" : { + "/crm/objects/2026-03/tasks" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "List", + "description" : "Read a page of tasks. Control what is returned via the `properties` query param.", + "operationId" : "get-/crm/objects/2026-03/tasks_getPage", + "parameters" : [ { + "name" : "after", + "in" : "query", + "description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "associations", + "in" : "query", + "description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum number of results to display per page.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 10 + } + }, { + "name" : "properties", + "in" : "query", + "description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "propertiesWithHistory", + "in" : "query", + "description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponseSimplePublicObjectWithAssociationsForwardPaging" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "post" : { + "tags" : [ "Basic" ], + "summary" : "Create", + "description" : "Create a task with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tasks is provided.", + "operationId" : "post-/crm/objects/2026-03/tasks_create", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectInputForCreate" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "headers" : { + "Location" : { + "description" : "URL of the newly created resource", + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/tasks/batch/archive" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Archive a batch of tasks by ID", + "description" : "Archive a batch of tasks by their IDs, moving them to the recycling bin. This operation requires a list of task IDs to be provided in the request body.", + "operationId" : "post-/crm/objects/2026-03/tasks/batch/archive_archive", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectId" + } + } + }, + "required" : true + }, + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/tasks/batch/create" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Create a batch of tasks", + "description" : "Create multiple tasks in a single request by providing a batch of task properties and associations. This endpoint allows for efficient task creation by processing multiple tasks together.", + "operationId" : "post-/crm/objects/2026-03/tasks/batch/create_create", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputForCreate" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/tasks/batch/read" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Read a batch of tasks by internal ID, or unique property values", + "description" : "Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ", + "operationId" : "post-/crm/objects/2026-03/tasks/batch/read_read", + "parameters" : [ { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchReadInputSimplePublicObjectId" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/tasks/batch/update" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Update a batch of tasks by internal ID, or unique property values", + "description" : "Update multiple tasks in a single request using their internal IDs or unique property values. This operation allows you to modify the properties of each task in the batch, ensuring efficient management of task data.", + "operationId" : "post-/crm/objects/2026-03/tasks/batch/update_update", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/tasks/batch/upsert" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Create or update a batch of tasks by unique property values", + "description" : "Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.", + "operationId" : "post-/crm/objects/2026-03/tasks/batch/upsert_upsert", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputUpsert" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicUpsertObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicUpsertObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/tasks/search" : { + "post" : { + "tags" : [ "Search" ], + "summary" : "Search for tasks using specified criteria.", + "description" : "Execute a search for tasks based on the provided criteria, including filters, properties, and sorting options. This allows for retrieving tasks that match specific conditions or property values.", + "operationId" : "post-/crm/objects/2026-03/tasks/search_doSearch", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PublicObjectSearchRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponseWithTotalSimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/tasks/{taskId}" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Read", + "description" : "Read an Object identified by `{taskId}`. `{taskId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.", + "operationId" : "get-/crm/objects/2026-03/tasks/{taskId}_getById", + "parameters" : [ { + "name" : "taskId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + }, { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "associations", + "in" : "query", + "description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "idProperty", + "in" : "query", + "description" : "The name of a property whose values are unique for this object type", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "properties", + "in" : "query", + "description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "propertiesWithHistory", + "in" : "query", + "description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "delete" : { + "tags" : [ "Basic" ], + "summary" : "Archive", + "description" : "Move an Object identified by `{taskId}` to the recycling bin.", + "operationId" : "delete-/crm/objects/2026-03/tasks/{taskId}_archive", + "parameters" : [ { + "name" : "taskId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "patch" : { + "tags" : [ "Basic" ], + "summary" : "Update", + "description" : "Perform a partial update of an Object identified by `{taskId}`or optionally a unique property value as specified by the `idProperty` query param. `{taskId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + "operationId" : "patch-/crm/objects/2026-03/tasks/{taskId}_update", + "parameters" : [ { + "name" : "taskId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + }, { + "name" : "idProperty", + "in" : "query", + "description" : "The name of a property whose values are unique for this object type", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}" : { + "put" : { + "tags" : [ "Batch" ], + "operationId" : "put-/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "fromObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "fromObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponsePublicDefaultAssociation" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}" : { + "put" : { + "tags" : [ "Basic" ], + "operationId" : "put-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "objectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AssociationSpec" + } + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "headers" : { + "Location" : { + "description" : "URL of the newly created resource", + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LabelsBetweenObjectPair" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "delete" : { + "tags" : [ "Basic" ], + "operationId" : "delete-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "objectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : true + } + } + } + }, + "components" : { + "schemas" : { + "AssociatedId" : { + "required" : [ "id", "type" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique identifier for the associated object." + }, + "type" : { + "type" : "string", + "description" : "The type of associations.", + "example" : "deal_to_contact" + } + }, + "description" : "Contains the id and type of an association" + }, + "AssociationSpec" : { + "required" : [ "associationCategory", "associationTypeId" ], + "type" : "object", + "properties" : { + "associationCategory" : { + "type" : "string", + "description" : "The category of the association, indicating its origin or purpose. Valid values include \"HUBSPOT_DEFINED\", \"USER_DEFINED\", \"INTEGRATOR_DEFINED\", and \"WORK\".", + "enum" : [ "HUBSPOT_DEFINED", "INTEGRATOR_DEFINED", "USER_DEFINED", "WORK" ] + }, + "associationTypeId" : { + "type" : "integer", + "description" : "An integer representing the unique identifier for the type of association.", + "format" : "int32" + } + }, + "description" : "Defines the type, direction, and details of the relationship between two CRM objects." + }, + "BatchInputSimplePublicObjectBatchInput" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be processed in the batch operation. Each object in the array contains the data necessary for the specific operation being performed.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInput" + } + } + }, + "description" : "Represents a batch input component used to handle multiple simple public objects in a single API request. This component is typically used when performing batch operations to create, update, or delete multiple records simultaneously." + }, + "BatchInputSimplePublicObjectBatchInputForCreate" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be created. Each object in the array contains the necessary data for creating a new entry in the system.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInputForCreate" + } + } + }, + "description" : "Represents a batch input for creating multiple simple public objects in a single request. This component is used to streamline the process of adding new objects to a HubSpot account by allowing multiple entries to be created at once." + }, + "BatchInputSimplePublicObjectBatchInputUpsert" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be upserted. Each object in the array contains the necessary data for creating or updating a record in HubSpot.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInputUpsert" + } + } + }, + "description" : "Represents a batch input operation for upserting simple public objects in HubSpot. This component is used to process multiple upsert operations in a single request, improving efficiency and performance." + }, + "BatchInputSimplePublicObjectId" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public object IDs to be processed in the batch operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectId" + } + } + }, + "description" : "Represents a batch input payload containing a list of simple public object IDs. This component is used when performing batch operations on multiple objects within HubSpot." + }, + "BatchReadInputSimplePublicObjectId" : { + "required" : [ "inputs", "properties", "propertiesWithHistory" ], + "type" : "object", + "properties" : { + "idProperty" : { + "type" : "string", + "description" : "When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID." + }, + "inputs" : { + "type" : "array", + "description" : "An array of SimplePublicObjectId objects, each containing the ID of an object to be read.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectId" + } + }, + "properties" : { + "type" : "array", + "description" : "An array of the property names to be returned in the response. If a specified property is not present on the requested object(s), it will be ignored.", + "items" : { + "type" : "string" + } + }, + "propertiesWithHistory" : { + "type" : "array", + "description" : "An array of the property names to be returned along with their history of previous values. If a specified property is not present on the requested object(s), it will be ignored.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property." + }, + "BatchResponsePublicDefaultAssociation" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "description" : "An array of StandardError objects detailing any errors that occurred during the batch operation.", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "numErrors" : { + "type" : "integer", + "description" : "The total number of errors that occurred during the operation.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of PublicDefaultAssociation objects representing the results of the batch operation.", + "items" : { + "$ref" : "#/components/schemas/PublicDefaultAssociation" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "The response returned after performing a batch operation on associations." + }, + "BatchResponseSimplePublicObject" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch request was initially made, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of SimplePublicObject items representing the results of the batch operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing began, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request: \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\"", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "A public object batch response object" + }, + "BatchResponseSimplePublicObjectWithErrors" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "numErrors" : { + "type" : "integer", + "description" : "The number of errors encountered during the batch process.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request - \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\"", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the result of a batch operation on CRM objects, including the processing status, batch results, timestamps, and a list of any errors encountered during the operation." + }, + "BatchResponseSimplePublicUpsertObject" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of SimplePublicUpsertObject items representing the results of the batch upsert operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicUpsertObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects." + }, + "BatchResponseSimplePublicUpsertObjectWithErrors" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "numErrors" : { + "type" : "integer", + "description" : "The number of errors encountered during the batch process.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SimplePublicUpsertObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the response from a batch upsert operation, including the status, timestamps, successfully processed objects, and any errors that occurred during processing." + }, + "CollectionResponseAssociatedId" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/Paging" + }, + "results" : { + "type" : "array", + "description" : "A list of associated IDs retrieved from the API request.", + "items" : { + "$ref" : "#/components/schemas/AssociatedId" + } + } + }, + "description" : "Represents a collection of associated IDs returned by an API request, including pagination details for navigating through the results." + }, + "CollectionResponseSimplePublicObjectWithAssociationsForwardPaging" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/ForwardPaging" + }, + "results" : { + "type" : "array", + "description" : "An array of simple public objects that are included in the current page of the response. Each object may include its associated data.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations" + } + } + }, + "description" : "Represents a paginated collection response that includes simple public objects with their associations. This component is used to handle the results and pagination details when retrieving a list of objects from the API." + }, + "CollectionResponseWithTotalSimplePublicObject" : { + "required" : [ "results", "total" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/Paging" + }, + "results" : { + "type" : "array", + "description" : "An array containing the simple public objects returned in the current page of the response. This property is required.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "total" : { + "type" : "integer", + "description" : "The number of available results", + "format" : "int32" + } + }, + "description" : "Represents a list of simple objects returned from an API request, along with the total count of objects available." + }, + "Error" : { + "required" : [ "category", "correlationId", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The error category" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}" + }, + "correlationId" : { + "type" : "string", + "description" : "A unique identifier for the request. Include this value with any error reports or support tickets", + "format" : "uuid", + "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf" + }, + "errors" : { + "type" : "array", + "description" : "further information about the error", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps" + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate", + "example" : "An error occurred" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered.", + "example" : { + "message" : "Invalid input (details will vary based on the error)", + "correlationId" : "aeb5f871-7f07-4993-9211-075dc63e7cbf", + "category" : "VALIDATION_ERROR", + "links" : { + "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base" + } + } + }, + "ErrorDetail" : { + "required" : [ "message" ], + "type" : "object", + "properties" : { + "code" : { + "type" : "string", + "description" : "The status code associated with the error detail" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{missingScopes=[scope1, scope2]}" + }, + "in" : { + "type" : "string", + "description" : "The name of the field or parameter in which the error was found." + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response." + }, + "Filter" : { + "required" : [ "operator", "propertyName" ], + "type" : "object", + "properties" : { + "highValue" : { + "type" : "string", + "description" : "The upper boundary value when using ranged-based filters." + }, + "operator" : { + "type" : "string", + "description" : "The comparison operator used in the filter, such as \"EQ\" or \"GT\".", + "enum" : [ "BETWEEN", "CONTAINS_TOKEN", "EQ", "GT", "GTE", "HAS_PROPERTY", "IN", "LT", "LTE", "NEQ", "NOT_CONTAINS_TOKEN", "NOT_HAS_PROPERTY", "NOT_IN" ] + }, + "propertyName" : { + "type" : "string", + "description" : "The name of the property to apply the filter to." + }, + "value" : { + "type" : "string", + "description" : "The value to match against the property." + }, + "values" : { + "type" : "array", + "description" : "The values to match against the property.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against. " + }, + "FilterGroup" : { + "required" : [ "filters" ], + "type" : "object", + "properties" : { + "filters" : { + "type" : "array", + "description" : "A list of individual filter criteria that are applied together as a group. Each filter specifies a condition that records must meet to be included in the results.", + "items" : { + "$ref" : "#/components/schemas/Filter" + } + } + }, + "description" : "Represents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints." + }, + "ForwardPaging" : { + "type" : "object", + "properties" : { + "next" : { + "$ref" : "#/components/schemas/NextPage" + } + }, + "description" : "Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page." + }, + "LabelsBetweenObjectPair" : { + "required" : [ "fromObjectId", "fromObjectTypeId", "labels", "toObjectId", "toObjectTypeId" ], + "type" : "object", + "properties" : { + "fromObjectId" : { + "type" : "string", + "description" : "Source unique ID of the object." + }, + "fromObjectTypeId" : { + "type" : "string", + "description" : "Source object type." + }, + "labels" : { + "type" : "array", + "description" : "An array of labels that describe the relationship between the two objects. This is a required property.", + "items" : { + "type" : "string" + } + }, + "toObjectId" : { + "type" : "string", + "description" : "Target unique ID of the object." + }, + "toObjectTypeId" : { + "type" : "string", + "description" : "Target object type." + } + }, + "description" : "The relationship descriptors applicable between two object types." + }, + "NextPage" : { + "required" : [ "after" ], + "type" : "object", + "properties" : { + "after" : { + "type" : "string", + "description" : "A paging cursor token for retrieving subsequent pages." + }, + "link" : { + "type" : "string", + "description" : "A URL that can be used to retrieve the next page results." + } + }, + "description" : "Specifies the paging information needed to retrieve the next set of results in a paginated API response" + }, + "Paging" : { + "type" : "object", + "properties" : { + "next" : { + "$ref" : "#/components/schemas/NextPage" + }, + "prev" : { + "$ref" : "#/components/schemas/PreviousPage" + } + }, + "description" : "Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results." + }, + "PreviousPage" : { + "required" : [ "before" ], + "type" : "object", + "properties" : { + "before" : { + "type" : "string", + "description" : "A paging cursor token for retrieving previous pages." + }, + "link" : { + "type" : "string", + "description" : "A URL that can be used to retrieve the previous pages' results." + } + }, + "description" : "specifies the paging information needed to retrieve the previous set of results in a paginated API response" + }, + "PublicAssociationsForObject" : { + "required" : [ "to", "types" ], + "type" : "object", + "properties" : { + "to" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "types" : { + "type" : "array", + "description" : "The types of associations that exist between the object and other entities, indicating the nature of their relationship.", + "items" : { + "$ref" : "#/components/schemas/AssociationSpec" + } + } + }, + "description" : "Represents the associations for a specific object in HubSpot, detailing the types of associations and the related objects involved." + }, + "PublicDefaultAssociation" : { + "required" : [ "associationSpec", "from", "to" ], + "type" : "object", + "properties" : { + "associationSpec" : { + "$ref" : "#/components/schemas/AssociationSpec" + }, + "from" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "to" : { + "$ref" : "#/components/schemas/PublicObjectId" + } + }, + "description" : "The PublicDefaultAssociation component represents the default association configuration between two objects in HubSpot. It is used to define how objects are related to each other within the platform." + }, + "PublicObjectId" : { + "required" : [ "id" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + } + }, + "description" : "Contains the Id of a Public Object" + }, + "PublicObjectSearchRequest" : { + "required" : [ "after", "filterGroups", "limit", "properties", "sorts" ], + "type" : "object", + "properties" : { + "after" : { + "type" : "string", + "description" : "A paging cursor token for retrieving subsequent pages." + }, + "filterGroups" : { + "type" : "array", + "description" : "Up to 6 groups of filters defining additional query criteria.", + "items" : { + "$ref" : "#/components/schemas/FilterGroup" + } + }, + "limit" : { + "type" : "integer", + "description" : "The maximum results to return, up to 200 objects.", + "format" : "int32" + }, + "properties" : { + "type" : "array", + "description" : "A list of property names to include in the response.", + "items" : { + "type" : "string" + } + }, + "query" : { + "type" : "string", + "description" : "The search query string, up to 3000 characters." + }, + "sorts" : { + "type" : "array", + "description" : "Specifies sorting order based on object properties.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Describes a search request" + }, + "PublicObjectWarning" : { + "required" : [ "category", "context", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The classification of the warning, indicating the type or nature of the issue." + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Additional information or metadata about the warning, providing context for understanding the issue." + }, + "message" : { + "type" : "string", + "description" : "The text of the warning message, providing information about the issue or alert." + } + }, + "description" : "Represents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning." + }, + "SimplePublicObject" : { + "required" : [ "archived", "createdAt", "id", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used to trace the write request for the object. Set a unique ID for each write operation; it is returned with any errors so you can identify which request encountered which error." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history, each with a timestamp and source information." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL associated with the object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "A simple public object." + }, + "SimplePublicObjectBatchInput" : { + "required" : [ "id", "properties" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id to be updated. This can be the object id, or the unique property value of the idProperty property" + }, + "idProperty" : { + "type" : "string", + "description" : "The name of a property whose values are unique for this object", + "example" : "my_unique_property_name" + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "A unique identifier for tracing the request." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs representing the properties of the object." + } + }, + "description" : "Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties." + }, + "SimplePublicObjectBatchInputForCreate" : { + "required" : [ "associations", "properties" ], + "type" : "object", + "properties" : { + "associations" : { + "type" : "array", + "description" : "An array of associations that define the relationships between the objects being created and other existing objects. This property is required.", + "items" : { + "$ref" : "#/components/schemas/PublicAssociationsForObject" + } + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the creation or update request of the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "An input object that contains a collection of objects to be created together in a batch." + }, + "SimplePublicObjectBatchInputUpsert" : { + "required" : [ "id", "properties" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "idProperty" : { + "type" : "string", + "description" : "The name of a property whose values are unique for this object" + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier for tracing the creation request." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID." + }, + "SimplePublicObjectId" : { + "required" : [ "id" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object.", + "example" : "430001" + } + }, + "description" : "Contains the Id of a Public Object" + }, + "SimplePublicObjectInput" : { + "required" : [ "properties" ], + "type" : "object", + "properties" : { + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "Represents the input required to update a CRM object, containing an object with property names and their corresponding values." + }, + "SimplePublicObjectInputForCreate" : { + "required" : [ "associations", "properties" ], + "type" : "object", + "properties" : { + "associations" : { + "type" : "array", + "description" : "An array that specifies the relationships between the new public object and existing objects. This is required to establish how the new object is connected within the system.", + "items" : { + "$ref" : "#/components/schemas/PublicAssociationsForObject" + } + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs for setting properties for the new object." + } + }, + "description" : "Is the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects." + }, + "SimplePublicObjectWithAssociations" : { + "required" : [ "archived", "createdAt", "id", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "associations" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/CollectionResponseAssociatedId" + }, + "description" : "A map of associated object types to their associated IDs." + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the creation or update request of the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL link to access this object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type." + }, + "SimplePublicUpsertObject" : { + "required" : [ "archived", "createdAt", "id", "new", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "new" : { + "type" : "boolean", + "description" : "Whether the property is new." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the write request for the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL associated with the object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "Represents a CRM object that has either been created or updated (upserted)" + }, + "StandardError" : { + "required" : [ "category", "context", "errors", "links", "message", "status" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The main category of the error." + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Additional context-specific information related to the error." + }, + "errors" : { + "type" : "array", + "description" : "The detailed error objects.", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "id" : { + "type" : "string", + "description" : "A unique ID for the error instance." + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "URLs linking to documentation or resources associated with the error." + }, + "message" : { + "type" : "string", + "description" : "A human-readable string describing the error and possible remediation steps." + }, + "status" : { + "type" : "string", + "description" : "A text status code for the error, typically \"error\"." + }, + "subCategory" : { + "type" : "object", + "properties" : { }, + "description" : "A more specific error category within each main category." + } + }, + "description" : "Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request." + }, + "ValueWithTimestamp" : { + "required" : [ "sourceType", "timestamp", "value" ], + "type" : "object", + "properties" : { + "sourceId" : { + "type" : "string", + "description" : "A string identifier for the specific source of the value." + }, + "sourceLabel" : { + "type" : "string", + "description" : "A human-readable label." + }, + "sourceType" : { + "type" : "string", + "description" : "A string indicating the type of source from which the value originated." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp when the property was updated, in ISO 8601 format.", + "format" : "date-time" + }, + "updatedByUserId" : { + "type" : "integer", + "description" : "The ID of the user who last updated the property.", + "format" : "int32" + }, + "value" : { + "type" : "string", + "description" : "The property value." + } + }, + "description" : "Property model that includes timestamp." + } + }, + "responses" : { + "Error" : { + "description" : "An error occurred.", + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + } + } + } + }, + "securitySchemes" : { + "developer_hapikey" : { + "type" : "apiKey", + "name" : "hapikey", + "in" : "query" + }, + "oauth2" : { + "type" : "oauth2", + "flows" : { + "authorizationCode" : { + "authorizationUrl" : "https://app.hubspot.com/oauth/authorize", + "tokenUrl" : "https://api.hubapi.com/oauth/v1/token", + "scopes" : { + "cpq.price_books.read" : "", + "crm.objects.appointments.read" : "", + "crm.objects.appointments.sensitive.read.v2" : "", + "crm.objects.appointments.sensitive.write.v2" : "", + "crm.objects.appointments.write" : "", + "crm.objects.calls.read" : "", + "crm.objects.calls.write" : "", + "crm.objects.carts.read" : "", + "crm.objects.carts.write" : "", + "crm.objects.commercepayments.read" : "", + "crm.objects.commercepayments.write" : "", + "crm.objects.companies.highly_sensitive.read.v2" : "", + "crm.objects.companies.highly_sensitive.write.v2" : "", + "crm.objects.companies.read" : "", + "crm.objects.companies.sensitive.read.v2" : "", + "crm.objects.companies.sensitive.write.v2" : "", + "crm.objects.companies.write" : "", + "crm.objects.contacts.highly_sensitive.read.v2" : "", + "crm.objects.contacts.highly_sensitive.write.v2" : "", + "crm.objects.contacts.read" : "", + "crm.objects.contacts.sensitive.read.v2" : "", + "crm.objects.contacts.sensitive.write.v2" : "", + "crm.objects.contacts.write" : "", + "crm.objects.contracts.read" : "", + "crm.objects.courses.read" : "", + "crm.objects.courses.write" : "", + "crm.objects.custom.highly_sensitive.read.v2" : "", + "crm.objects.custom.highly_sensitive.write.v2" : "", + "crm.objects.custom.read" : "", + "crm.objects.custom.sensitive.read.v2" : "", + "crm.objects.custom.sensitive.write.v2" : "", + "crm.objects.custom.write" : "", + "crm.objects.deals.highly_sensitive.read.v2" : "", + "crm.objects.deals.highly_sensitive.write.v2" : "", + "crm.objects.deals.read" : "", + "crm.objects.deals.sensitive.read.v2" : "", + "crm.objects.deals.sensitive.write.v2" : "", + "crm.objects.deals.write" : "", + "crm.objects.emails.read" : "", + "crm.objects.emails.write" : "", + "crm.objects.feedback_submissions.read" : "", + "crm.objects.forecasts.read" : "", + "crm.objects.goals.read" : "", + "crm.objects.goals.write" : "", + "crm.objects.invoices.read" : "", + "crm.objects.invoices.write" : "", + "crm.objects.leads.read" : "", + "crm.objects.leads.write" : "", + "crm.objects.line_items.read" : "", + "crm.objects.line_items.write" : "", + "crm.objects.listings.read" : "", + "crm.objects.listings.write" : "", + "crm.objects.meetings.read" : "", + "crm.objects.meetings.write" : "", + "crm.objects.notes.read" : "", + "crm.objects.notes.write" : "", + "crm.objects.orders.read" : "", + "crm.objects.orders.write" : "", + "crm.objects.partner-clients.read" : "", + "crm.objects.partner-clients.write" : "", + "crm.objects.partner-services.read" : "", + "crm.objects.partner-services.write" : "", + "crm.objects.products.read" : "", + "crm.objects.products.write" : "", + "crm.objects.projects.highly_sensitive.read" : "", + "crm.objects.projects.highly_sensitive.write" : "", + "crm.objects.projects.read" : "", + "crm.objects.projects.sensitive.read" : "", + "crm.objects.projects.sensitive.write" : "", + "crm.objects.projects.write" : "", + "crm.objects.quotes.read" : "", + "crm.objects.quotes.write" : "", + "crm.objects.services.read" : "", + "crm.objects.services.write" : "", + "crm.objects.subscriptions.read" : "", + "crm.objects.subscriptions.write" : "", + "crm.objects.tasks.read" : "", + "crm.objects.tasks.write" : "", + "crm.objects.tickets.highly_sensitive.read" : "", + "crm.objects.tickets.highly_sensitive.write" : "", + "crm.objects.tickets.read" : "", + "crm.objects.tickets.sensitive.read" : "", + "crm.objects.tickets.sensitive.write" : "", + "crm.objects.tickets.write" : "", + "crm.objects.users.read" : "", + "crm.objects.users.write" : "", + "e-commerce" : "", + "media_bridge.read" : "", + "oauth" : "", + "revenue.contracts.read" : "", + "tickets.highly_sensitive.v2" : "", + "tickets.sensitive.v2" : "" + } + } + }, + "x-hubspot-app-availability" : { + "cpq.price_books.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.appointments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.commercepayments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.commercepayments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.companies.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.contacts.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contracts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.custom.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.feedback_submissions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.forecasts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-clients.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-clients.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.products.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.products.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "e-commerce" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "media_bridge.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "oauth" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "revenue.contracts.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "tickets.highly_sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "tickets.sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + } + } + } + } + }, + "x-hubspot-available-client-libraries" : [ "Node", "Python", "Ruby", "PHP" ], + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + } +} \ No newline at end of file diff --git a/spec/hubspot/tickets.json b/spec/hubspot/tickets.json new file mode 100644 index 0000000..818ee15 --- /dev/null +++ b/spec/hubspot/tickets.json @@ -0,0 +1,3162 @@ +{ + "openapi" : "3.0.1", + "info" : { + "title" : "Tickets", + "description" : "Basepom for all HubSpot Projects", + "version" : "2026-03", + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + }, + "x-hubspot-api-use-case" : "When a customer contacts your support team to request help with an issue, create a ticket to track that request and keep a record of it for future reference.", + "x-hubspot-introduction" : "Use the tickets API to create and manage CRM records that represent customer service requests in your CRM." + }, + "servers" : [ { + "url" : "https://api.hubapi.com" + } ], + "tags" : [ { + "name" : "Advanced" + }, { + "name" : "Basic" + }, { + "name" : "Batch" + }, { + "name" : "Search" + } ], + "paths" : { + "/crm/objects/2026-03/tickets" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "List", + "description" : "Read a page of tickets. Control what is returned via the `properties` query param.", + "operationId" : "get-/crm/objects/2026-03/tickets_getPage", + "parameters" : [ { + "name" : "after", + "in" : "query", + "description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "associations", + "in" : "query", + "description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum number of results to display per page.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 10 + } + }, { + "name" : "properties", + "in" : "query", + "description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "propertiesWithHistory", + "in" : "query", + "description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponseSimplePublicObjectWithAssociationsForwardPaging" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "post" : { + "tags" : [ "Basic" ], + "summary" : "Create", + "description" : "Create a ticket with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tickets is provided.", + "operationId" : "post-/crm/objects/2026-03/tickets_create", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectInputForCreate" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "headers" : { + "Location" : { + "description" : "URL of the newly created resource", + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/tickets/batch/archive" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Archive a batch of tickets by ID", + "description" : "Delete a batch of tickets by ID. Deleted tickets can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).", + "operationId" : "post-/crm/objects/2026-03/tickets/batch/archive_archive", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectId" + } + } + }, + "required" : true + }, + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/tickets/batch/create" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Create a batch of tickets", + "description" : "Create a batch of tickets. The `inputs` array can contain a `properties` object to define property values for the ticket, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.", + "operationId" : "post-/crm/objects/2026-03/tickets/batch/create_create", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputForCreate" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/tickets/batch/read" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Read a batch of tickets by internal ID, or unique property values", + "description" : "Retrieve a batch of tickets by ID (`ticketId`) or unique property value (`idProperty`). ", + "operationId" : "post-/crm/objects/2026-03/tickets/batch/read_read", + "parameters" : [ { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchReadInputSimplePublicObjectId" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/tickets/batch/update" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Update a batch of tickets by internal ID, or unique property values", + "description" : "Update a batch of tickets by ID (`ticketId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + "operationId" : "post-/crm/objects/2026-03/tickets/batch/update_update", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/tickets/batch/upsert" : { + "post" : { + "tags" : [ "Batch" ], + "summary" : "Create or update a batch of tickets by unique property values", + "description" : "Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.", + "operationId" : "post-/crm/objects/2026-03/tickets/batch/upsert_upsert", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputUpsert" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicUpsertObject" + } + } + } + }, + "207" : { + "description" : "multiple statuses", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponseSimplePublicUpsertObjectWithErrors" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/tickets/merge" : { + "post" : { + "tags" : [ "Advanced" ], + "summary" : "Merge two tickets", + "description" : "Merge two tickets, combining them into one ticket record.", + "operationId" : "post-/crm/objects/2026-03/tickets/merge_merge", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PublicMergeInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/tickets/search" : { + "post" : { + "tags" : [ "Search" ], + "summary" : "Search for tickets", + "description" : "Search for tickets by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).", + "operationId" : "post-/crm/objects/2026-03/tickets/search_doSearch", + "parameters" : [ ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PublicObjectSearchRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CollectionResponseWithTotalSimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/tickets/{ticketId}" : { + "get" : { + "tags" : [ "Basic" ], + "summary" : "Read", + "description" : "Read an Object identified by `{ticketId}`. `{ticketId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.", + "operationId" : "get-/crm/objects/2026-03/tickets/{ticketId}_getById", + "parameters" : [ { + "name" : "ticketId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + }, { + "name" : "archived", + "in" : "query", + "description" : "Whether to return only results that have been archived.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "associations", + "in" : "query", + "description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "idProperty", + "in" : "query", + "description" : "The name of a property whose values are unique for this object type", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "properties", + "in" : "query", + "description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "propertiesWithHistory", + "in" : "query", + "description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "delete" : { + "tags" : [ "Basic" ], + "summary" : "Archive", + "description" : "Move an Object identified by `{ticketId}` to the recycling bin.", + "operationId" : "delete-/crm/objects/2026-03/tickets/{ticketId}_archive", + "parameters" : [ { + "name" : "ticketId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "patch" : { + "tags" : [ "Basic" ], + "summary" : "Update", + "description" : "Perform a partial update of an Object identified by `{ticketId}`or optionally a unique property value as specified by the `idProperty` query param. `{ticketId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + "operationId" : "patch-/crm/objects/2026-03/tickets/{ticketId}_update", + "parameters" : [ { + "name" : "ticketId", + "in" : "path", + "required" : true, + "schema" : { + "pattern" : ".+", + "type" : "string" + } + }, { + "name" : "idProperty", + "in" : "query", + "description" : "The name of a property whose values are unique for this object type", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObjectInput" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}" : { + "put" : { + "tags" : [ "Batch" ], + "operationId" : "put-/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "fromObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "fromObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BatchResponsePublicDefaultAssociation" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + } + }, + "/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}" : { + "put" : { + "tags" : [ "Basic" ], + "operationId" : "put-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "objectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AssociationSpec" + } + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "successful operation", + "headers" : { + "Location" : { + "description" : "URL of the newly created resource", + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LabelsBetweenObjectPair" + } + } + } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : false + } + }, + "delete" : { + "tags" : [ "Basic" ], + "operationId" : "delete-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + "parameters" : [ { + "name" : "objectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "objectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectId", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "toObjectType", + "in" : "path", + "description" : "", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No content", + "content" : { } + }, + "default" : { + "description" : "", + "$ref" : "#/components/responses/Error" + } + }, + "security" : [ { + "oauth2" : [ "crm.objects.tickets.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.read" ] + }, { + "oauth2" : [ "crm.objects.deals.read" ] + }, { + "oauth2" : [ "crm.objects.services.read" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.orders.read" ] + }, { + "oauth2" : [ "crm.objects.listings.write" ] + }, { + "oauth2" : [ "crm.objects.custom.read" ] + }, { + "oauth2" : [ "crm.objects.companies.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.tasks.read" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.companies.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.forecasts.read" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.tickets.sensitive.write" ] + }, { + "oauth2" : [ "media_bridge.read" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.write" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.read" ] + }, { + "oauth2" : [ "crm.objects.users.write" ] + }, { + "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.meetings.read" ] + }, { + "oauth2" : [ "crm.objects.users.read" ] + }, { + "oauth2" : [ "crm.objects.orders.write" ] + }, { + "oauth2" : [ "crm.objects.partner-services.read" ] + }, { + "oauth2" : [ "crm.objects.partner-services.write" ] + }, { + "oauth2" : [ "crm.objects.appointments.write" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.carts.write" ] + }, { + "oauth2" : [ "crm.objects.tickets.highly_sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.tasks.write" ] + }, { + "oauth2" : [ "crm.objects.commercepayments.read" ] + }, { + "oauth2" : [ "revenue.contracts.read" ] + }, { + "oauth2" : [ "crm.objects.feedback_submissions.read" ] + }, { + "oauth2" : [ "crm.objects.products.write" ] + }, { + "oauth2" : [ "crm.objects.services.write" ] + }, { + "oauth2" : [ "crm.objects.emails.write" ] + }, { + "oauth2" : [ "crm.objects.subscriptions.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.contacts.read" ] + }, { + "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] + }, { + "oauth2" : [ "cpq.price_books.read" ] + }, { + "oauth2" : [ "crm.objects.meetings.write" ] + }, { + "oauth2" : [ "crm.objects.invoices.read" ] + }, { + "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.custom.write" ] + }, { + "oauth2" : [ "crm.objects.notes.write" ] + }, { + "oauth2" : [ "tickets.sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.write" ] + }, { + "oauth2" : [ "e-commerce" ] + }, { + "oauth2" : [ "crm.objects.appointments.read" ] + }, { + "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.read" ] + }, { + "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] + }, { + "oauth2" : [ "crm.objects.calls.write" ] + }, { + "oauth2" : [ "crm.objects.goals.write" ] + }, { + "oauth2" : [ "crm.objects.line_items.write" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.write" ] + }, { + "oauth2" : [ "crm.objects.goals.read" ] + }, { + "oauth2" : [ "crm.objects.line_items.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.write" ] + }, { + "oauth2" : [ "crm.objects.projects.write" ] + }, { + "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.projects.sensitive.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.write" ] + }, { + "oauth2" : [ "tickets.highly_sensitive.v2" ] + }, { + "oauth2" : [ "crm.objects.leads.read" ] + }, { + "oauth2" : [ "crm.objects.leads.write" ] + }, { + "oauth2" : [ "crm.objects.carts.read" ] + }, { + "oauth2" : [ "crm.objects.emails.read" ] + }, { + "oauth2" : [ "crm.objects.courses.write" ] + }, { + "oauth2" : [ "crm.objects.quotes.read" ] + }, { + "oauth2" : [ "crm.objects.partner-clients.read" ] + }, { + "oauth2" : [ "crm.objects.courses.read" ] + }, { + "oauth2" : [ "crm.objects.notes.read" ] + }, { + "oauth2" : [ "crm.objects.listings.read" ] + }, { + "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] + }, { + "oauth2" : [ "crm.objects.products.read" ] + }, { + "oauth2" : [ "oauth" ] + } ], + "x-hubspot-user-level-auth" : { + "internalOnly" : true + } + } + } + }, + "components" : { + "schemas" : { + "AssociatedId" : { + "required" : [ "id", "type" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique identifier for the associated object." + }, + "type" : { + "type" : "string", + "description" : "The type of associations.", + "example" : "deal_to_contact" + } + }, + "description" : "Contains the id and type of an association" + }, + "AssociationSpec" : { + "required" : [ "associationCategory", "associationTypeId" ], + "type" : "object", + "properties" : { + "associationCategory" : { + "type" : "string", + "description" : "The category of the association, indicating its origin or purpose. Valid values include \"HUBSPOT_DEFINED\", \"USER_DEFINED\", \"INTEGRATOR_DEFINED\", and \"WORK\".", + "enum" : [ "HUBSPOT_DEFINED", "INTEGRATOR_DEFINED", "USER_DEFINED", "WORK" ] + }, + "associationTypeId" : { + "type" : "integer", + "description" : "An integer representing the unique identifier for the type of association.", + "format" : "int32" + } + }, + "description" : "Defines the type, direction, and details of the relationship between two CRM objects." + }, + "BatchInputSimplePublicObjectBatchInput" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be processed in the batch operation. Each object in the array contains the data necessary for the specific operation being performed.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInput" + } + } + }, + "description" : "Represents a batch input component used to handle multiple simple public objects in a single API request. This component is typically used when performing batch operations to create, update, or delete multiple records simultaneously." + }, + "BatchInputSimplePublicObjectBatchInputForCreate" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be created. Each object in the array contains the necessary data for creating a new entry in the system.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInputForCreate" + } + } + }, + "description" : "Represents a batch input for creating multiple simple public objects in a single request. This component is used to streamline the process of adding new objects to a HubSpot account by allowing multiple entries to be created at once." + }, + "BatchInputSimplePublicObjectBatchInputUpsert" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public objects to be upserted. Each object in the array contains the necessary data for creating or updating a record in HubSpot.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectBatchInputUpsert" + } + } + }, + "description" : "Represents a batch input operation for upserting simple public objects in HubSpot. This component is used to process multiple upsert operations in a single request, improving efficiency and performance." + }, + "BatchInputSimplePublicObjectId" : { + "required" : [ "inputs" ], + "type" : "object", + "properties" : { + "inputs" : { + "type" : "array", + "description" : "An array of simple public object IDs to be processed in the batch operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectId" + } + } + }, + "description" : "Represents a batch input payload containing a list of simple public object IDs. This component is used when performing batch operations on multiple objects within HubSpot." + }, + "BatchReadInputSimplePublicObjectId" : { + "required" : [ "inputs", "properties", "propertiesWithHistory" ], + "type" : "object", + "properties" : { + "idProperty" : { + "type" : "string", + "description" : "When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID." + }, + "inputs" : { + "type" : "array", + "description" : "An array of SimplePublicObjectId objects, each containing the ID of an object to be read.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectId" + } + }, + "properties" : { + "type" : "array", + "description" : "An array of the property names to be returned in the response. If a specified property is not present on the requested object(s), it will be ignored.", + "items" : { + "type" : "string" + } + }, + "propertiesWithHistory" : { + "type" : "array", + "description" : "An array of the property names to be returned along with their history of previous values. If a specified property is not present on the requested object(s), it will be ignored.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property." + }, + "BatchResponsePublicDefaultAssociation" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "description" : "An array of StandardError objects detailing any errors that occurred during the batch operation.", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "numErrors" : { + "type" : "integer", + "description" : "The total number of errors that occurred during the operation.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of PublicDefaultAssociation objects representing the results of the batch operation.", + "items" : { + "$ref" : "#/components/schemas/PublicDefaultAssociation" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "The response returned after performing a batch operation on associations." + }, + "BatchResponseSimplePublicObject" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch request was initially made, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of SimplePublicObject items representing the results of the batch operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch processing began, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. The expected value is \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "A public object batch response object" + }, + "BatchResponseSimplePublicObjectWithErrors" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "numErrors" : { + "type" : "integer", + "description" : "The number of errors encountered during the batch process.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request - \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\"", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the result of a batch operation on CRM objects, including the processing status, batch results, timestamps, and a list of any errors encountered during the operation." + }, + "BatchResponseSimplePublicUpsertObject" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs, providing additional information or actions related to the batch operation." + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "description" : "An array of SimplePublicUpsertObject items representing the results of the batch upsert operation.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicUpsertObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. The expected value is \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects." + }, + "BatchResponseSimplePublicUpsertObjectWithErrors" : { + "required" : [ "completedAt", "results", "startedAt", "status" ], + "type" : "object", + "properties" : { + "completedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", + "format" : "date-time" + }, + "errors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StandardError" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "An object containing relevant links related to the batch request." + }, + "numErrors" : { + "type" : "integer", + "description" : "The number of errors encountered during the batch process.", + "format" : "int32" + }, + "requestedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", + "format" : "date-time" + }, + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SimplePublicUpsertObject" + } + }, + "startedAt" : { + "type" : "string", + "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\".", + "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] + } + }, + "description" : "Represents the response from a batch upsert operation, including the status, timestamps, successfully processed objects, and any errors that occurred during processing." + }, + "CollectionResponseAssociatedId" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/Paging" + }, + "results" : { + "type" : "array", + "description" : "A list of associated IDs retrieved from the API request.", + "items" : { + "$ref" : "#/components/schemas/AssociatedId" + } + } + }, + "description" : "Represents a collection of associated IDs returned by an API request, including pagination details for navigating through the results." + }, + "CollectionResponseSimplePublicObjectWithAssociationsForwardPaging" : { + "required" : [ "results" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/ForwardPaging" + }, + "results" : { + "type" : "array", + "description" : "An array of simple public objects that are included in the current page of the response. Each object may include its associated data.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations" + } + } + }, + "description" : "Represents a paginated collection response that includes simple public objects with their associations. This component is used to handle the results and pagination details when retrieving a list of objects from the API." + }, + "CollectionResponseWithTotalSimplePublicObject" : { + "required" : [ "results", "total" ], + "type" : "object", + "properties" : { + "paging" : { + "$ref" : "#/components/schemas/Paging" + }, + "results" : { + "type" : "array", + "description" : "An array containing the simple public objects returned in the current page of the response. This property is required.", + "items" : { + "$ref" : "#/components/schemas/SimplePublicObject" + } + }, + "total" : { + "type" : "integer", + "description" : "The number of available results", + "format" : "int32" + } + }, + "description" : "Represents a list of simple objects returned from an API request, along with the total count of objects available." + }, + "Error" : { + "required" : [ "category", "correlationId", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The error category" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}" + }, + "correlationId" : { + "type" : "string", + "description" : "A unique identifier for the request. Include this value with any error reports or support tickets", + "format" : "uuid", + "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf" + }, + "errors" : { + "type" : "array", + "description" : "further information about the error", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps" + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate", + "example" : "An error occurred" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered.", + "example" : { + "message" : "Invalid input (details will vary based on the error)", + "correlationId" : "aeb5f871-7f07-4993-9211-075dc63e7cbf", + "category" : "VALIDATION_ERROR", + "links" : { + "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base" + } + } + }, + "ErrorDetail" : { + "required" : [ "message" ], + "type" : "object", + "properties" : { + "code" : { + "type" : "string", + "description" : "The status code associated with the error detail" + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Context about the error condition", + "example" : "{missingScopes=[scope1, scope2]}" + }, + "in" : { + "type" : "string", + "description" : "The name of the field or parameter in which the error was found." + }, + "message" : { + "type" : "string", + "description" : "A human readable message describing the error along with remediation steps where appropriate" + }, + "subCategory" : { + "type" : "string", + "description" : "A specific category that contains more specific detail about the error" + } + }, + "description" : "Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response." + }, + "Filter" : { + "required" : [ "operator", "propertyName" ], + "type" : "object", + "properties" : { + "highValue" : { + "type" : "string", + "description" : "The upper boundary value when using ranged-based filters." + }, + "operator" : { + "type" : "string", + "description" : "The comparison operator used in the filter, such as \"EQ\" or \"GT\".", + "enum" : [ "BETWEEN", "CONTAINS_TOKEN", "EQ", "GT", "GTE", "HAS_PROPERTY", "IN", "LT", "LTE", "NEQ", "NOT_CONTAINS_TOKEN", "NOT_HAS_PROPERTY", "NOT_IN" ] + }, + "propertyName" : { + "type" : "string", + "description" : "The name of the property to apply the filter to." + }, + "value" : { + "type" : "string", + "description" : "The value to match against the property." + }, + "values" : { + "type" : "array", + "description" : "The values to match against the property.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against. " + }, + "FilterGroup" : { + "required" : [ "filters" ], + "type" : "object", + "properties" : { + "filters" : { + "type" : "array", + "description" : "A list of individual filter criteria that are applied together as a group. Each filter specifies a condition that records must meet to be included in the results.", + "items" : { + "$ref" : "#/components/schemas/Filter" + } + } + }, + "description" : "Represents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints." + }, + "ForwardPaging" : { + "type" : "object", + "properties" : { + "next" : { + "$ref" : "#/components/schemas/NextPage" + } + }, + "description" : "Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page." + }, + "LabelsBetweenObjectPair" : { + "required" : [ "fromObjectId", "fromObjectTypeId", "labels", "toObjectId", "toObjectTypeId" ], + "type" : "object", + "properties" : { + "fromObjectId" : { + "type" : "string", + "description" : "Source unique ID of the object." + }, + "fromObjectTypeId" : { + "type" : "string", + "description" : "Source object type." + }, + "labels" : { + "type" : "array", + "description" : "An array of labels that describe the relationship between the two objects. This is a required property.", + "items" : { + "type" : "string" + } + }, + "toObjectId" : { + "type" : "string", + "description" : "Target unique ID of the object." + }, + "toObjectTypeId" : { + "type" : "string", + "description" : "Target object type." + } + }, + "description" : "The relationship descriptors applicable between two object types." + }, + "NextPage" : { + "required" : [ "after" ], + "type" : "object", + "properties" : { + "after" : { + "type" : "string", + "description" : "A paging cursor token for retrieving subsequent pages." + }, + "link" : { + "type" : "string", + "description" : "A URL that can be used to retrieve the next page results." + } + }, + "description" : "Specifies the paging information needed to retrieve the next set of results in a paginated API response" + }, + "Paging" : { + "type" : "object", + "properties" : { + "next" : { + "$ref" : "#/components/schemas/NextPage" + }, + "prev" : { + "$ref" : "#/components/schemas/PreviousPage" + } + }, + "description" : "Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results." + }, + "PreviousPage" : { + "required" : [ "before" ], + "type" : "object", + "properties" : { + "before" : { + "type" : "string", + "description" : "A paging cursor token for retrieving previous pages." + }, + "link" : { + "type" : "string", + "description" : "A URL that can be used to retrieve the previous pages' results." + } + }, + "description" : "specifies the paging information needed to retrieve the previous set of results in a paginated API response" + }, + "PublicAssociationsForObject" : { + "required" : [ "to", "types" ], + "type" : "object", + "properties" : { + "to" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "types" : { + "type" : "array", + "description" : "The types of associations that exist between the object and other entities, indicating the nature of their relationship.", + "items" : { + "$ref" : "#/components/schemas/AssociationSpec" + } + } + }, + "description" : "Represents the associations for a specific object in HubSpot, detailing the types of associations and the related objects involved." + }, + "PublicDefaultAssociation" : { + "required" : [ "associationSpec", "from", "to" ], + "type" : "object", + "properties" : { + "associationSpec" : { + "$ref" : "#/components/schemas/AssociationSpec" + }, + "from" : { + "$ref" : "#/components/schemas/PublicObjectId" + }, + "to" : { + "$ref" : "#/components/schemas/PublicObjectId" + } + }, + "description" : "The PublicDefaultAssociation component represents the default association configuration between two objects in HubSpot. It is used to define how objects are related to each other within the platform." + }, + "PublicMergeInput" : { + "required" : [ "objectIdToMerge", "primaryObjectId" ], + "type" : "object", + "properties" : { + "objectIdToMerge" : { + "type" : "string", + "description" : "The ID of the object that will be merged into the primary object." + }, + "primaryObjectId" : { + "type" : "string", + "description" : "The ID of the primary object into which another object will be merged." + } + }, + "description" : "Input data for merging two records." + }, + "PublicObjectId" : { + "required" : [ "id" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + } + }, + "description" : "Contains the Id of a Public Object" + }, + "PublicObjectSearchRequest" : { + "required" : [ "after", "filterGroups", "limit", "properties", "sorts" ], + "type" : "object", + "properties" : { + "after" : { + "type" : "string", + "description" : "A paging cursor token for retrieving subsequent pages." + }, + "filterGroups" : { + "type" : "array", + "description" : "Up to 6 groups of filters defining additional query criteria.", + "items" : { + "$ref" : "#/components/schemas/FilterGroup" + } + }, + "limit" : { + "type" : "integer", + "description" : "The maximum results to return, up to 200 objects.", + "format" : "int32" + }, + "properties" : { + "type" : "array", + "description" : "A list of property names to include in the response.", + "items" : { + "type" : "string" + } + }, + "query" : { + "type" : "string", + "description" : "The search query string, up to 3000 characters." + }, + "sorts" : { + "type" : "array", + "description" : "Specifies sorting order based on object properties.", + "items" : { + "type" : "string" + } + } + }, + "description" : "Describes a search request" + }, + "PublicObjectWarning" : { + "required" : [ "category", "context", "message" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The classification of the warning, indicating the type or nature of the issue." + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Additional information or metadata about the warning, providing context for understanding the issue." + }, + "message" : { + "type" : "string", + "description" : "The text of the warning message, providing information about the issue or alert." + } + }, + "description" : "Represents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning." + }, + "SimplePublicObject" : { + "required" : [ "archived", "createdAt", "id", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used to trace the write request for the object. Set a unique ID for each write operation; it is returned with any errors so you can identify which request encountered which error." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history, each with a timestamp and source information." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL associated with the object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "A simple public object." + }, + "SimplePublicObjectBatchInput" : { + "required" : [ "id", "properties" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id to be updated. This can be the object id, or the unique property value of the idProperty property" + }, + "idProperty" : { + "type" : "string", + "description" : "The name of a property whose values are unique for this object", + "example" : "my_unique_property_name" + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "A unique identifier for tracing the request." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs representing the properties of the object." + } + }, + "description" : "Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties." + }, + "SimplePublicObjectBatchInputForCreate" : { + "required" : [ "associations", "properties" ], + "type" : "object", + "properties" : { + "associations" : { + "type" : "array", + "description" : "An array of associations that define the relationships between the objects being created and other existing objects. This property is required.", + "items" : { + "$ref" : "#/components/schemas/PublicAssociationsForObject" + } + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the creation or update request of the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "An input object that contains a collection of objects to be created together in a batch." + }, + "SimplePublicObjectBatchInputUpsert" : { + "required" : [ "id", "properties" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "idProperty" : { + "type" : "string", + "description" : "The name of a property whose values are unique for this object" + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier for tracing the creation request." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID." + }, + "SimplePublicObjectId" : { + "required" : [ "id" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The unique ID of the object.", + "example" : "430001" + } + }, + "description" : "Contains the Id of a Public Object" + }, + "SimplePublicObjectInput" : { + "required" : [ "properties" ], + "type" : "object", + "properties" : { + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + } + }, + "description" : "Represents the input required to update a CRM object, containing an object with property names and their corresponding values." + }, + "SimplePublicObjectInputForCreate" : { + "required" : [ "associations", "properties" ], + "type" : "object", + "properties" : { + "associations" : { + "type" : "array", + "description" : "An array that specifies the relationships between the new public object and existing objects. This is required to establish how the new object is connected within the system.", + "items" : { + "$ref" : "#/components/schemas/PublicAssociationsForObject" + } + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key-value pairs for setting properties for the new object." + } + }, + "description" : "Is the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects." + }, + "SimplePublicObjectWithAssociations" : { + "required" : [ "archived", "createdAt", "id", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "associations" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/CollectionResponseAssociatedId" + }, + "description" : "A map of associated object types to their associated IDs." + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the creation or update request of the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL link to access this object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type." + }, + "SimplePublicUpsertObject" : { + "required" : [ "archived", "createdAt", "id", "new", "properties", "updatedAt" ], + "type" : "object", + "properties" : { + "archived" : { + "type" : "boolean", + "description" : "Whether the object is archived." + }, + "archivedAt" : { + "type" : "string", + "description" : "The timestamp when the object was archived, in ISO 8601 format.", + "format" : "date-time" + }, + "createdAt" : { + "type" : "string", + "description" : "The timestamp when the object was created, in ISO 8601 format.", + "format" : "date-time" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the object." + }, + "new" : { + "type" : "boolean", + "description" : "Whether the property is new." + }, + "objectWriteTraceId" : { + "type" : "string", + "description" : "An identifier used for tracing the write request for the object." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Key value pairs representing the properties of the object." + }, + "propertiesWithHistory" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ValueWithTimestamp" + } + }, + "description" : "Key-value pairs representing the properties of the object along with their history." + }, + "updatedAt" : { + "type" : "string", + "description" : "The timestamp when the object was last updated, in ISO 8601 format.", + "format" : "date-time" + }, + "url" : { + "type" : "string", + "description" : "The URL associated with the object." + }, + "warnings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PublicObjectWarning" + } + } + }, + "description" : "Represents a CRM object that has either been created or updated (upserted)" + }, + "StandardError" : { + "required" : [ "category", "context", "errors", "links", "message", "status" ], + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The main category of the error." + }, + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : "Additional context-specific information related to the error." + }, + "errors" : { + "type" : "array", + "description" : "The detailed error objects.", + "items" : { + "$ref" : "#/components/schemas/ErrorDetail" + } + }, + "id" : { + "type" : "string", + "description" : "A unique ID for the error instance." + }, + "links" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + }, + "description" : "URLs linking to documentation or resources associated with the error." + }, + "message" : { + "type" : "string", + "description" : "A human-readable string describing the error and possible remediation steps." + }, + "status" : { + "type" : "string", + "description" : "A text status code for the error, typically \"error\"." + }, + "subCategory" : { + "type" : "object", + "properties" : { }, + "description" : "A more specific error category within each main category." + } + }, + "description" : "Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request." + }, + "ValueWithTimestamp" : { + "required" : [ "sourceType", "timestamp", "value" ], + "type" : "object", + "properties" : { + "sourceId" : { + "type" : "string", + "description" : "A string identifier for the specific source of the value." + }, + "sourceLabel" : { + "type" : "string", + "description" : "A human-readable label." + }, + "sourceType" : { + "type" : "string", + "description" : "A string indicating the type of source from which the value originated." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp when the property was updated, in ISO 8601 format.", + "format" : "date-time" + }, + "updatedByUserId" : { + "type" : "integer", + "description" : "The ID of the user who last updated the property.", + "format" : "int32" + }, + "value" : { + "type" : "string", + "description" : "The property value." + } + }, + "description" : "Property model that includes timestamp." + } + }, + "responses" : { + "Error" : { + "description" : "An error occurred.", + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + } + } + } + }, + "securitySchemes" : { + "developer_hapikey" : { + "type" : "apiKey", + "name" : "hapikey", + "in" : "query" + }, + "oauth2" : { + "type" : "oauth2", + "flows" : { + "authorizationCode" : { + "authorizationUrl" : "https://app.hubspot.com/oauth/authorize", + "tokenUrl" : "https://api.hubapi.com/oauth/v1/token", + "scopes" : { + "cpq.price_books.read" : "", + "crm.objects.appointments.read" : "", + "crm.objects.appointments.sensitive.read.v2" : "", + "crm.objects.appointments.sensitive.write.v2" : "", + "crm.objects.appointments.write" : "", + "crm.objects.calls.read" : "", + "crm.objects.calls.write" : "", + "crm.objects.carts.read" : "", + "crm.objects.carts.write" : "", + "crm.objects.commercepayments.read" : "", + "crm.objects.commercepayments.write" : "", + "crm.objects.companies.highly_sensitive.read.v2" : "", + "crm.objects.companies.highly_sensitive.write.v2" : "", + "crm.objects.companies.read" : "", + "crm.objects.companies.sensitive.read.v2" : "", + "crm.objects.companies.sensitive.write.v2" : "", + "crm.objects.companies.write" : "", + "crm.objects.contacts.highly_sensitive.read.v2" : "", + "crm.objects.contacts.highly_sensitive.write.v2" : "", + "crm.objects.contacts.read" : "", + "crm.objects.contacts.sensitive.read.v2" : "", + "crm.objects.contacts.sensitive.write.v2" : "", + "crm.objects.contacts.write" : "", + "crm.objects.contracts.read" : "", + "crm.objects.courses.read" : "", + "crm.objects.courses.write" : "", + "crm.objects.custom.highly_sensitive.read.v2" : "", + "crm.objects.custom.highly_sensitive.write.v2" : "", + "crm.objects.custom.read" : "", + "crm.objects.custom.sensitive.read.v2" : "", + "crm.objects.custom.sensitive.write.v2" : "", + "crm.objects.custom.write" : "", + "crm.objects.deals.highly_sensitive.read.v2" : "", + "crm.objects.deals.highly_sensitive.write.v2" : "", + "crm.objects.deals.read" : "", + "crm.objects.deals.sensitive.read.v2" : "", + "crm.objects.deals.sensitive.write.v2" : "", + "crm.objects.deals.write" : "", + "crm.objects.emails.read" : "", + "crm.objects.emails.write" : "", + "crm.objects.feedback_submissions.read" : "", + "crm.objects.forecasts.read" : "", + "crm.objects.goals.read" : "", + "crm.objects.goals.write" : "", + "crm.objects.invoices.read" : "", + "crm.objects.invoices.write" : "", + "crm.objects.leads.read" : "", + "crm.objects.leads.write" : "", + "crm.objects.line_items.read" : "", + "crm.objects.line_items.write" : "", + "crm.objects.listings.read" : "", + "crm.objects.listings.write" : "", + "crm.objects.meetings.read" : "", + "crm.objects.meetings.write" : "", + "crm.objects.notes.read" : "", + "crm.objects.notes.write" : "", + "crm.objects.orders.read" : "", + "crm.objects.orders.write" : "", + "crm.objects.partner-clients.read" : "", + "crm.objects.partner-clients.write" : "", + "crm.objects.partner-services.read" : "", + "crm.objects.partner-services.write" : "", + "crm.objects.products.read" : "", + "crm.objects.products.write" : "", + "crm.objects.projects.highly_sensitive.read" : "", + "crm.objects.projects.highly_sensitive.write" : "", + "crm.objects.projects.read" : "", + "crm.objects.projects.sensitive.read" : "", + "crm.objects.projects.sensitive.write" : "", + "crm.objects.projects.write" : "", + "crm.objects.quotes.read" : "", + "crm.objects.quotes.write" : "", + "crm.objects.services.read" : "", + "crm.objects.services.write" : "", + "crm.objects.subscriptions.read" : "", + "crm.objects.subscriptions.write" : "", + "crm.objects.tasks.read" : "", + "crm.objects.tasks.write" : "", + "crm.objects.tickets.highly_sensitive.read" : "", + "crm.objects.tickets.highly_sensitive.write" : "", + "crm.objects.tickets.read" : "", + "crm.objects.tickets.sensitive.read" : "", + "crm.objects.tickets.sensitive.write" : "", + "crm.objects.tickets.write" : "", + "crm.objects.users.read" : "", + "crm.objects.users.write" : "", + "e-commerce" : "", + "media_bridge.read" : "", + "oauth" : "", + "revenue.contracts.read" : "", + "tickets.highly_sensitive.v2" : "", + "tickets.sensitive.v2" : "" + } + } + }, + "x-hubspot-app-availability" : { + "cpq.price_books.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.appointments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.appointments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.calls.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.carts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.commercepayments.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.commercepayments.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.companies.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.companies.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.contacts.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.contacts.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.contracts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.courses.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.custom.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.custom.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.highly_sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.highly_sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : true + }, + "crm.objects.deals.sensitive.read.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.sensitive.write.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.deals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.emails.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.feedback_submissions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.forecasts.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.goals.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.invoices.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.leads.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.line_items.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.listings.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.meetings.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.notes.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.orders.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-clients.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-clients.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.partner-services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.products.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.products.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.highly_sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.read" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.sensitive.write" : { + "portal" : [ "private" ], + "developer" : false + }, + "crm.objects.projects.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.quotes.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.services.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.subscriptions.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tasks.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.highly_sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.read" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.read" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.sensitive.write" : { + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.tickets.write" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "crm.objects.users.write" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "e-commerce" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "media_bridge.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "oauth" : { + "portal" : [ "public", "private" ], + "user" : [ "public", "private" ], + "developer" : false + }, + "revenue.contracts.read" : { + "portal" : [ "public", "private" ], + "developer" : false + }, + "tickets.highly_sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + }, + "tickets.sensitive.v2" : { + "portal" : [ "private" ], + "developer" : false + } + } + } + } + }, + "x-hubspot-available-client-libraries" : [ "Node", "Python", "Ruby", "PHP" ], + "x-hubspot-product-tier-requirements" : { + "marketing" : "FREE", + "sales" : "FREE", + "service" : "FREE", + "cms" : "FREE", + "commerce" : "FREE", + "crmHub" : "FREE", + "dataHub" : "FREE" + } +} \ No newline at end of file diff --git a/src/api.test.ts b/src/api.test.ts index a692934..69497da 100644 --- a/src/api.test.ts +++ b/src/api.test.ts @@ -8,7 +8,7 @@ import { definitions } from "./generated/definitions.js" import { FAKE_TOKEN } from "./testing/fake-comments.js" import { runCli } from "./testing/harness.js" -const configFile = join(process.env.HUBSPOT_CONFIG_DIR ?? "", "config.json") +const configFile = join(process.env.WCHUBSPOT_CONFIG_DIR ?? "", "config.json") const withPermissions = (permissions: Record) => { mkdirSync(join(configFile, ".."), { recursive: true }) writeFileSync(configFile, JSON.stringify({ profiles: { personal: { permissions } } })) diff --git a/src/comments.test.ts b/src/comments.test.ts index 169aeb4..219da91 100644 --- a/src/comments.test.ts +++ b/src/comments.test.ts @@ -11,7 +11,7 @@ import { run } from "./program.js" import { FAKE_TOKEN, fakeComments } from "./testing/fake-comments.js" import { runCli, signedIn } from "./testing/harness.js" -const configFile = join(process.env.HUBSPOT_CONFIG_DIR ?? "", "config.json") +const configFile = join(process.env.WCHUBSPOT_CONFIG_DIR ?? "", "config.json") const withPermissions = (permissions: Record) => { mkdirSync(join(configFile, ".."), { recursive: true }) writeFileSync(configFile, JSON.stringify({ profiles: { personal: { permissions } } })) @@ -98,7 +98,7 @@ it("a deny on a write, or the read-only lock, stops it before any request", asyn rmSync(configFile) const locked = await runCli(["personal", "comments", "create", "--text", "Plan", "--json"], { service, - env: { HUBSPOT_READ_ONLY: "1" }, + env: { WCHUBSPOT_READ_ONLY: "1" }, }) expect(locked.code).toBe(5) expect(service.calls).toEqual([]) diff --git a/src/generated/definitions.ts b/src/generated/definitions.ts index c7c9c3c..ab528e1 100644 --- a/src/generated/definitions.ts +++ b/src/generated/definitions.ts @@ -5,52 +5,3104 @@ import type { SchemaNode } from "@wirecat/cli-base/codegen" export const definitions: Readonly> = { - NewComment: { + AssociatedId: { + description: "Contains the id and type of an association", type: "object", properties: { - text: { + id: { + description: "The unique identifier for the associated object.", + type: "string", + }, + type: { + description: "The type of associations.", + type: "string", + }, + }, + required: ["id", "type"], + }, + AssociationSpec: { + description: "Defines the type, direction, and details of the relationship between two CRM objects.", + type: "object", + properties: { + associationCategory: { + description: + 'The category of the association, indicating its origin or purpose. Valid values include "HUBSPOT_DEFINED", "USER_DEFINED", "INTEGRATOR_DEFINED", and "WORK".', + type: "string", + enum: ["HUBSPOT_DEFINED", "INTEGRATOR_DEFINED", "USER_DEFINED", "WORK"], + }, + associationTypeId: { + description: "An integer representing the unique identifier for the type of association.", + type: "integer", + format: "int32", + }, + }, + required: ["associationCategory", "associationTypeId"], + }, + BatchInputSimplePublicObjectBatchInput: { + description: + "Represents a batch input component used to handle multiple simple public objects in a single API request. This component is typically used when performing batch operations to create, update, or delete multiple records simultaneously.", + type: "object", + properties: { + inputs: { + description: + "An array of simple public objects to be processed in the batch operation. Each object in the array contains the data necessary for the specific operation being performed.", + type: "array", + items: { + type: "ref", + ref: "SimplePublicObjectBatchInput", + }, + }, + }, + required: ["inputs"], + }, + BatchInputSimplePublicObjectBatchInputForCreate: { + description: + "Represents a batch input for creating multiple simple public objects in a single request. This component is used to streamline the process of adding new objects to a HubSpot account by allowing multiple entries to be created at once.", + type: "object", + properties: { + inputs: { + description: + "An array of simple public objects to be created. Each object in the array contains the necessary data for creating a new entry in the system.", + type: "array", + items: { + type: "ref", + ref: "SimplePublicObjectBatchInputForCreate", + }, + }, + }, + required: ["inputs"], + }, + BatchInputSimplePublicObjectBatchInputUpsert: { + description: + "Represents a batch input operation for upserting simple public objects in HubSpot. This component is used to process multiple upsert operations in a single request, improving efficiency and performance.", + type: "object", + properties: { + inputs: { + description: + "An array of simple public objects to be upserted. Each object in the array contains the necessary data for creating or updating a record in HubSpot.", + type: "array", + items: { + type: "ref", + ref: "SimplePublicObjectBatchInputUpsert", + }, + }, + }, + required: ["inputs"], + }, + BatchInputSimplePublicObjectId: { + description: + "Represents a batch input payload containing a list of simple public object IDs. This component is used when performing batch operations on multiple objects within HubSpot.", + type: "object", + properties: { + inputs: { + description: "An array of simple public object IDs to be processed in the batch operation.", + type: "array", + items: { + type: "ref", + ref: "SimplePublicObjectId", + }, + }, + }, + required: ["inputs"], + }, + BatchReadInputSimplePublicObjectId: { + description: + "Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property.", + type: "object", + properties: { + idProperty: { + description: + "When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.", + type: "string", + }, + inputs: { + description: "An array of SimplePublicObjectId objects, each containing the ID of an object to be read.", + type: "array", + items: { + type: "ref", + ref: "SimplePublicObjectId", + }, + }, + properties: { + description: + "An array of the property names to be returned in the response. If a specified property is not present on the requested object(s), it will be ignored.", + type: "array", + items: { + type: "string", + }, + }, + propertiesWithHistory: { + description: + "An array of the property names to be returned along with their history of previous values. If a specified property is not present on the requested object(s), it will be ignored.", + type: "array", + items: { + type: "string", + }, + }, + }, + required: ["inputs", "properties", "propertiesWithHistory"], + }, + BatchResponsePublicDefaultAssociation: { + description: "The response returned after performing a batch operation on associations.", + type: "object", + properties: { + completedAt: { + description: "The timestamp when the batch process was completed, in ISO 8601 format.", + type: "string", + }, + errors: { + description: "An array of StandardError objects detailing any errors that occurred during the batch operation.", + type: "array", + items: { + type: "ref", + ref: "StandardError", + }, + }, + links: { + description: + "A map of link names to associated URIs, providing additional information or actions related to the batch operation.", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + numErrors: { + description: "The total number of errors that occurred during the operation.", + type: "integer", + format: "int32", + }, + requestedAt: { + description: "The timestamp when the batch process was initiated, in ISO 8601 format.", + type: "string", + }, + results: { + description: "An array of PublicDefaultAssociation objects representing the results of the batch operation.", + type: "array", + items: { + type: "ref", + ref: "PublicDefaultAssociation", + }, + }, + startedAt: { + description: "The timestamp when the batch process began execution, in ISO 8601 format.", + type: "string", + }, + status: { + description: + 'The status of the batch processing request. Can be: "PENDING", "PROCESSING", "CANCELED", or "COMPLETE".', + type: "string", + enum: ["CANCELED", "COMPLETE", "PENDING", "PROCESSING"], + }, + }, + required: ["completedAt", "results", "startedAt", "status"], + }, + BatchResponseSimplePublicObject: { + description: "A public object batch response object", + type: "object", + properties: { + completedAt: { + description: "The timestamp when the batch processing was completed, in ISO 8601 format.", + type: "string", + }, + links: { + description: + "A map of link names to associated URIs, providing additional information or actions related to the batch operation.", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + requestedAt: { + description: "The timestamp when the batch request was initially made, in ISO 8601 format.", + type: "string", + }, + results: { + description: "An array of SimplePublicObject items representing the results of the batch operation.", + type: "array", + items: { + type: "ref", + ref: "SimplePublicObject", + }, + }, + startedAt: { + description: "The timestamp when the batch processing began, in ISO 8601 format.", + type: "string", + }, + status: { + description: 'The status of the batch processing request. The expected value is "COMPLETE".', + type: "string", + enum: ["CANCELED", "COMPLETE", "PENDING", "PROCESSING"], + }, + }, + required: ["completedAt", "results", "startedAt", "status"], + }, + BatchResponseSimplePublicObjectWithErrors: { + description: + "Represents the result of a batch operation on CRM objects, including the processing status, batch results, timestamps, and a list of any errors encountered during the operation.", + type: "object", + properties: { + completedAt: { + description: "The timestamp when the batch process was completed, in ISO 8601 format.", + type: "string", + }, + errors: { + type: "array", + items: { + type: "ref", + ref: "StandardError", + }, + }, + links: { + description: "An object containing relevant links related to the batch request.", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + numErrors: { + description: "The number of errors encountered during the batch process.", + type: "integer", + format: "int32", + }, + requestedAt: { + description: "The timestamp when the batch process was initiated, in ISO 8601 format.", + type: "string", + }, + results: { + type: "array", + items: { + type: "ref", + ref: "SimplePublicObject", + }, + }, + startedAt: { + description: "The timestamp when the batch process began execution, in ISO 8601 format.", + type: "string", + }, + status: { + description: 'The status of the batch processing request - "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE"', + type: "string", + enum: ["CANCELED", "COMPLETE", "PENDING", "PROCESSING"], + }, + }, + required: ["completedAt", "results", "startedAt", "status"], + }, + BatchResponseSimplePublicUpsertObject: { + description: + "Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.", + type: "object", + properties: { + completedAt: { + description: "The timestamp when the batch process was completed, in ISO 8601 format.", + type: "string", + }, + links: { + description: + "A map of link names to associated URIs, providing additional information or actions related to the batch operation.", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + requestedAt: { + description: "The timestamp when the batch process was initiated, in ISO 8601 format.", + type: "string", + }, + results: { + description: + "An array of SimplePublicUpsertObject items representing the results of the batch upsert operation.", + type: "array", + items: { + type: "ref", + ref: "SimplePublicUpsertObject", + }, + }, + startedAt: { + description: "The timestamp when the batch process began execution, in ISO 8601 format.", + type: "string", + }, + status: { + description: + 'The status of the batch processing request. Can be: "PENDING", "PROCESSING", "CANCELED", or "COMPLETE".', + type: "string", + enum: ["CANCELED", "COMPLETE", "PENDING", "PROCESSING"], + }, + }, + required: ["completedAt", "results", "startedAt", "status"], + }, + BatchResponseSimplePublicUpsertObjectWithErrors: { + description: + "Represents the response from a batch upsert operation, including the status, timestamps, successfully processed objects, and any errors that occurred during processing.", + type: "object", + properties: { + completedAt: { + description: "The timestamp when the batch process was completed, in ISO 8601 format.", + type: "string", + }, + errors: { + type: "array", + items: { + type: "ref", + ref: "StandardError", + }, + }, + links: { + description: "An object containing relevant links related to the batch request.", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + numErrors: { + description: "The number of errors encountered during the batch process.", + type: "integer", + format: "int32", + }, + requestedAt: { + description: "The timestamp when the batch process was initiated, in ISO 8601 format.", + type: "string", + }, + results: { + type: "array", + items: { + type: "ref", + ref: "SimplePublicUpsertObject", + }, + }, + startedAt: { + description: "The timestamp when the batch process began execution, in ISO 8601 format.", + type: "string", + }, + status: { + description: + 'The status of the batch processing request. Can be: "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE".', + type: "string", + enum: ["CANCELED", "COMPLETE", "PENDING", "PROCESSING"], + }, + }, + required: ["completedAt", "results", "startedAt", "status"], + }, + CollectionResponseAssociatedId: { + description: + "Represents a collection of associated IDs returned by an API request, including pagination details for navigating through the results.", + type: "object", + properties: { + paging: { + type: "ref", + ref: "Paging", + }, + results: { + description: "A list of associated IDs retrieved from the API request.", + type: "array", + items: { + type: "ref", + ref: "AssociatedId", + }, + }, + }, + required: ["results"], + }, + CollectionResponseSimplePublicObjectWithAssociationsForwardPaging: { + description: + "Represents a paginated collection response that includes simple public objects with their associations. This component is used to handle the results and pagination details when retrieving a list of objects from the API.", + type: "object", + properties: { + paging: { + type: "ref", + ref: "ForwardPaging", + }, + results: { + description: + "An array of simple public objects that are included in the current page of the response. Each object may include its associated data.", + type: "array", + items: { + type: "ref", + ref: "SimplePublicObjectWithAssociations", + }, + }, + }, + required: ["results"], + }, + CollectionResponseWithTotalSimplePublicObject: { + description: + "Represents a list of simple objects returned from an API request, along with the total count of objects available.", + type: "object", + properties: { + paging: { + type: "ref", + ref: "Paging", + }, + results: { + description: + "An array containing the simple public objects returned in the current page of the response. This property is required.", + type: "array", + items: { + type: "ref", + ref: "SimplePublicObject", + }, + }, + total: { + description: "The number of available results", + type: "integer", + format: "int32", + }, + }, + required: ["results", "total"], + }, + ApiError: { + description: + "Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered.", + type: "object", + properties: { + category: { + description: "The error category", + type: "string", + }, + context: { + description: "Context about the error condition", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "array", + items: { + type: "string", + }, + }, + }, + correlationId: { + description: + "A unique identifier for the request. Include this value with any error reports or support tickets", + type: "string", + }, + errors: { + description: "further information about the error", + type: "array", + items: { + type: "ref", + ref: "ErrorDetail", + }, + }, + links: { + description: + "A map of link names to associated URIs containing documentation about the error or recommended remediation steps", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + message: { + description: "A human readable message describing the error along with remediation steps where appropriate", + type: "string", + }, + subCategory: { + description: "A specific category that contains more specific detail about the error", + type: "string", + }, + }, + required: ["category", "correlationId", "message"], + }, + ErrorDetail: { + description: + "Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response.", + type: "object", + properties: { + code: { + description: "The status code associated with the error detail", + type: "string", + }, + context: { + description: "Context about the error condition", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "array", + items: { + type: "string", + }, + }, + }, + in: { + description: "The name of the field or parameter in which the error was found.", + type: "string", + }, + message: { + description: "A human readable message describing the error along with remediation steps where appropriate", + type: "string", + }, + subCategory: { + description: "A specific category that contains more specific detail about the error", + type: "string", + }, + }, + required: ["message"], + }, + Filter: { + description: + "Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against. ", + type: "object", + properties: { + highValue: { + description: "The upper boundary value when using ranged-based filters.", + type: "string", + }, + operator: { + description: 'The comparison operator used in the filter, such as "EQ" or "GT".', + type: "string", + enum: [ + "BETWEEN", + "CONTAINS_TOKEN", + "EQ", + "GT", + "GTE", + "HAS_PROPERTY", + "IN", + "LT", + "LTE", + "NEQ", + "NOT_CONTAINS_TOKEN", + "NOT_HAS_PROPERTY", + "NOT_IN", + ], + }, + propertyName: { + description: "The name of the property to apply the filter to.", + type: "string", + }, + value: { + description: "The value to match against the property.", + type: "string", + }, + values: { + description: "The values to match against the property.", + type: "array", + items: { + type: "string", + }, + }, + }, + required: ["operator", "propertyName"], + }, + FilterGroup: { + description: + "Represents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints.", + type: "object", + properties: { + filters: { + description: + "A list of individual filter criteria that are applied together as a group. Each filter specifies a condition that records must meet to be included in the results.", + type: "array", + items: { + type: "ref", + ref: "Filter", + }, + }, + }, + required: ["filters"], + }, + ForwardPaging: { + description: + "Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.", + type: "object", + properties: { + next: { + type: "ref", + ref: "NextPage", + }, + }, + required: [], + }, + LabelsBetweenObjectPair: { + description: "The relationship descriptors applicable between two object types.", + type: "object", + properties: { + fromObjectId: { + description: "Source unique ID of the object.", + type: "string", + }, + fromObjectTypeId: { + description: "Source object type.", + type: "string", + }, + labels: { + description: + "An array of labels that describe the relationship between the two objects. This is a required property.", + type: "array", + items: { + type: "string", + }, + }, + toObjectId: { + description: "Target unique ID of the object.", + type: "string", + }, + toObjectTypeId: { + description: "Target object type.", + type: "string", + }, + }, + required: ["fromObjectId", "fromObjectTypeId", "labels", "toObjectId", "toObjectTypeId"], + }, + NextPage: { + description: + "Specifies the paging information needed to retrieve the next set of results in a paginated API response", + type: "object", + properties: { + after: { + description: "A paging cursor token for retrieving subsequent pages.", + type: "string", + }, + link: { + description: "A URL that can be used to retrieve the next page results.", + type: "string", + }, + }, + required: ["after"], + }, + Paging: { + description: + "Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.", + type: "object", + properties: { + next: { + type: "ref", + ref: "NextPage", + }, + prev: { + type: "ref", + ref: "PreviousPage", + }, + }, + required: [], + }, + PreviousPage: { + description: + "specifies the paging information needed to retrieve the previous set of results in a paginated API response", + type: "object", + properties: { + before: { + description: "A paging cursor token for retrieving previous pages.", + type: "string", + }, + link: { + description: "A URL that can be used to retrieve the previous pages' results.", + type: "string", + }, + }, + required: ["before"], + }, + PublicAssociationsForObject: { + description: + "Represents the associations for a specific object in HubSpot, detailing the types of associations and the related objects involved.", + type: "object", + properties: { + to: { + type: "ref", + ref: "PublicObjectId", + }, + types: { + description: + "The types of associations that exist between the object and other entities, indicating the nature of their relationship.", + type: "array", + items: { + type: "ref", + ref: "AssociationSpec", + }, + }, + }, + required: ["to", "types"], + }, + PublicDefaultAssociation: { + description: + "The PublicDefaultAssociation component represents the default association configuration between two objects in HubSpot. It is used to define how objects are related to each other within the platform.", + type: "object", + properties: { + associationSpec: { + type: "ref", + ref: "AssociationSpec", + }, + from: { + type: "ref", + ref: "PublicObjectId", + }, + to: { + type: "ref", + ref: "PublicObjectId", + }, + }, + required: ["associationSpec", "from", "to"], + }, + PublicGdprDeleteInput: { + description: "An input that contains the information required to process a public GDPR data deletion request.", + type: "object", + properties: { + idProperty: { + description: + "The name of a property whose values are unique for this object. An alternative to identifying a contact by ID.", + type: "string", + }, + objectId: { + description: "The ID of the contact to permanently delete.", + type: "string", + }, + }, + required: ["objectId"], + }, + PublicMergeInput: { + description: "Input data for merging two records.", + type: "object", + properties: { + objectIdToMerge: { + description: "The object ID of the record that the merge will not set as the current value after the merge.", + type: "string", + }, + primaryObjectId: { + description: + "The object ID of the record that the merge will generally set as the current value after the merge.", + type: "string", + }, + }, + required: ["objectIdToMerge", "primaryObjectId"], + }, + PublicObjectId: { + description: "Contains the Id of a Public Object", + type: "object", + properties: { + id: { + description: "The unique ID of the object.", + type: "string", + }, + }, + required: ["id"], + }, + PublicObjectSearchRequest: { + description: "Describes a search request", + type: "object", + properties: { + after: { + description: "A paging cursor token for retrieving subsequent pages.", + type: "string", + }, + filterGroups: { + description: "Up to 6 groups of filters defining additional query criteria.", + type: "array", + items: { + type: "ref", + ref: "FilterGroup", + }, + }, + limit: { + description: "The maximum results to return, up to 200 objects.", + type: "integer", + format: "int32", + }, + properties: { + description: "A list of property names to include in the response.", + type: "array", + items: { + type: "string", + }, + }, + query: { + description: "The search query string, up to 3000 characters.", + type: "string", + }, + sorts: { + description: "Specifies sorting order based on object properties.", + type: "array", + items: { + type: "string", + }, + }, + }, + required: ["after", "filterGroups", "limit", "properties", "sorts"], + }, + PublicObjectWarning: { + description: + "Represents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning.", + type: "object", + properties: { + category: { + description: "The classification of the warning, indicating the type or nature of the issue.", + type: "string", + }, + context: { + description: + "Additional information or metadata about the warning, providing context for understanding the issue.", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + message: { + description: "The text of the warning message, providing information about the issue or alert.", + type: "string", + }, + }, + required: ["category", "context", "message"], + }, + SimplePublicObject: { + description: "A simple public object.", + type: "object", + properties: { + archived: { + description: "Whether the object is archived.", + type: "boolean", + }, + archivedAt: { + description: "The timestamp when the object was archived, in ISO 8601 format.", + type: "string", + }, + createdAt: { + description: "The timestamp when the object was created, in ISO 8601 format.", + type: "string", + }, + id: { + description: "The unique ID of the object.", + type: "string", + }, + objectWriteTraceId: { + description: + "An identifier used to trace the write request for the object. Set a unique ID for each write operation; it is returned with any errors so you can identify which request encountered which error.", + type: "string", + }, + properties: { + description: "Key-value pairs representing the properties of the object.", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + propertiesWithHistory: { + description: + "Key-value pairs representing the properties of the object along with their history, each with a timestamp and source information.", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "array", + items: { + type: "ref", + ref: "ValueWithTimestamp", + }, + }, + }, + updatedAt: { + description: "The timestamp when the object was last updated, in ISO 8601 format.", + type: "string", + }, + url: { + description: "The URL associated with the object.", + type: "string", + }, + warnings: { + type: "array", + items: { + type: "ref", + ref: "PublicObjectWarning", + }, + }, + }, + required: ["archived", "createdAt", "id", "properties", "updatedAt"], + }, + SimplePublicObjectBatchInput: { + description: + "Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties.", + type: "object", + properties: { + id: { + description: + "The ID of the contact to update. This can be the object ID, or the unique property value of the `idProperty` property.", + type: "string", + }, + idProperty: { + description: "The name of a unique property, when identifying records by property. ", + type: "string", + }, + objectWriteTraceId: { + description: "A unique identifier for tracing the request.", + type: "string", + }, + properties: { + description: "Key-value pairs representing the properties of the object.", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + }, + required: ["id", "properties"], + }, + SimplePublicObjectBatchInputForCreate: { + description: "An input object that contains a collection of objects to be created together in a batch.", + type: "object", + properties: { + associations: { + description: + "An array of associations that define the relationships between the objects being created and other existing objects. This property is required.", + type: "array", + items: { + type: "ref", + ref: "PublicAssociationsForObject", + }, + }, + objectWriteTraceId: { + description: "An identifier used for tracing the creation or update request of the object.", + type: "string", + }, + properties: { + description: "Key value pairs representing the properties of the object.", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + }, + required: ["associations", "properties"], + }, + SimplePublicObjectBatchInputUpsert: { + description: + "Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID.", + type: "object", + properties: { + id: { + description: "The unique ID of the object.", + type: "string", + }, + idProperty: { + description: "The name of a property whose values are unique for this object", + type: "string", + }, + objectWriteTraceId: { + description: "An identifier for tracing the creation request.", + type: "string", + }, + properties: { + description: "Key value pairs representing the properties of the object.", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + }, + required: ["id", "properties"], + }, + SimplePublicObjectId: { + description: "Contains the Id of a Public Object", + type: "object", + properties: { + id: { + description: "The unique ID of the object.", + type: "string", + }, + }, + required: ["id"], + }, + SimplePublicObjectInput: { + description: + "Represents the input required to update a CRM object, containing an object with property names and their corresponding values.", + type: "object", + properties: { + properties: { + description: "Key value pairs representing the properties of the object.", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + }, + required: ["properties"], + }, + SimplePublicObjectInputForCreate: { + description: + "Is the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects.", + type: "object", + properties: { + associations: { + description: + "An array that specifies the relationships between the new public object and existing objects. This is required to establish how the new object is connected within the system.", + type: "array", + items: { + type: "ref", + ref: "PublicAssociationsForObject", + }, + }, + properties: { + description: "Key-value pairs for setting properties for the new object.", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + }, + required: ["associations", "properties"], + }, + SimplePublicObjectWithAssociations: { + description: + "Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.", + type: "object", + properties: { + archived: { + description: "Whether the object is archived.", + type: "boolean", + }, + archivedAt: { + description: "The timestamp when the object was archived, in ISO 8601 format.", + type: "string", + }, + associations: { + description: "A map of associated object types to their associated IDs.", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "ref", + ref: "CollectionResponseAssociatedId", + }, + }, + createdAt: { + description: "The timestamp when the object was created, in ISO 8601 format.", + type: "string", + }, + id: { + description: "The unique ID of the object.", + type: "string", + }, + objectWriteTraceId: { + description: "An identifier used for tracing the creation or update request of the object.", + type: "string", + }, + properties: { + description: "Key value pairs representing the properties of the object.", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + propertiesWithHistory: { + description: "Key-value pairs representing the properties of the object along with their history.", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "array", + items: { + type: "ref", + ref: "ValueWithTimestamp", + }, + }, + }, + updatedAt: { + description: "The timestamp when the object was last updated, in ISO 8601 format.", + type: "string", + }, + url: { + description: "The URL link to access this object.", + type: "string", + }, + warnings: { + type: "array", + items: { + type: "ref", + ref: "PublicObjectWarning", + }, + }, + }, + required: ["archived", "createdAt", "id", "properties", "updatedAt"], + }, + SimplePublicUpsertObject: { + description: "Represents a CRM object that has either been created or updated (upserted)", + type: "object", + properties: { + archived: { + description: "Whether the object is archived.", + type: "boolean", + }, + archivedAt: { + description: "The timestamp when the object was archived, in ISO 8601 format.", + type: "string", + }, + createdAt: { + description: "The timestamp when the object was created, in ISO 8601 format.", + type: "string", + }, + id: { + description: "The unique ID of the object.", + type: "string", + }, + "new": { + description: "Whether the property is new.", + type: "boolean", + }, + objectWriteTraceId: { + description: "An identifier for tracing the creation request.", + type: "string", + }, + properties: { + description: "Key value pairs representing the properties of the object.", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + propertiesWithHistory: { + description: "Key-value pairs representing the properties of the object along with their history.", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "array", + items: { + type: "ref", + ref: "ValueWithTimestamp", + }, + }, + }, + updatedAt: { + description: "The timestamp when the object was last updated, in ISO 8601 format.", + type: "string", + }, + url: { + description: "The URL associated with the object.", + type: "string", + }, + warnings: { + type: "array", + items: { + type: "ref", + ref: "PublicObjectWarning", + }, + }, + }, + required: ["archived", "createdAt", "id", "new", "properties", "updatedAt"], + }, + StandardError: { + description: + "Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request.", + type: "object", + properties: { + category: { + description: "The main category of the error.", + type: "string", + }, + context: { + description: "Additional context-specific information related to the error.", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "array", + items: { + type: "string", + }, + }, + }, + errors: { + description: "The detailed error objects.", + type: "array", + items: { + type: "ref", + ref: "ErrorDetail", + }, + }, + id: { + description: "A unique ID for the error instance.", + type: "string", + }, + links: { + description: "URLs linking to documentation or resources associated with the error.", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + message: { + description: "A human-readable string describing the error and possible remediation steps.", + type: "string", + }, + status: { + description: 'A text status code for the error, typically "error".', + type: "string", + }, + subCategory: { + description: "A more specific error category within each main category.", + type: "object", + properties: {}, + required: [], + }, + }, + required: ["category", "context", "errors", "links", "message", "status"], + }, + ValueWithTimestamp: { + description: "Property model that includes timestamp.", + type: "object", + properties: { + sourceId: { + description: "A string identifier for the specific source of the value.", + type: "string", + }, + sourceLabel: { + description: "A human-readable label.", + type: "string", + }, + sourceType: { + description: "A string indicating the type of source from which the value originated.", + type: "string", + }, + timestamp: { + description: "The timestamp when the property was updated, in ISO 8601 format.", + type: "string", + }, + updatedByUserId: { + description: "The ID of the user who last updated the property.", + type: "integer", + format: "int32", + }, + value: { + description: "The property value.", + type: "string", + }, + }, + required: ["sourceType", "timestamp", "value"], + }, + CollectionResponsePublicOwnerForwardPaging: { + type: "object", + properties: { + paging: { + type: "ref", + ref: "ForwardPaging", + }, + results: { + description: + "An array of PublicOwner objects, each representing an individual owner with their specific details.", + type: "array", + items: { + type: "ref", + ref: "PublicOwner", + }, + }, + }, + required: ["results"], + }, + PublicOwner: { + type: "object", + properties: { + archived: { + description: "Indicates whether the owner is archived.", + type: "boolean", + }, + createdAt: { + description: "The date and time when the owner was created.", + type: "string", + }, + email: { + description: "The email address of the owner.", + type: "string", + }, + firstName: { + description: "The first name of the owner.", + type: "string", + }, + id: { + description: "The unique identifier of the owner.", + type: "string", + }, + lastName: { + description: "The last name of the owner.", + type: "string", + }, + teams: { + description: + "An array of teams associated with the owner, where each team is represented by a PublicTeam object.", + type: "array", + items: { + type: "ref", + ref: "PublicTeam", + }, + }, + type: { + description: "The type of the owner, which can be either PERSON or QUEUE.", + type: "string", + enum: ["PERSON", "QUEUE"], + }, + updatedAt: { + description: "The date and time when the owner was last updated.", + type: "string", + }, + userId: { + description: "The user ID of the owner.", + type: "integer", + format: "int32", + }, + userIdIncludingInactive: { + description: "The user ID of the owner, including inactive users.", + type: "integer", + format: "int32", + }, + }, + required: ["archived", "createdAt", "id", "type", "updatedAt"], + }, + PublicTeam: { + type: "object", + properties: { + id: { + description: "The unique identifier for the team, represented as a string.", + type: "string", + }, + name: { + description: "The name of the team, represented as a string.", + type: "string", + }, + primary: { + description: "A boolean indicating whether this team is the primary team.", + type: "boolean", + }, + }, + required: ["id", "name", "primary"], + }, + CollectionResponsePipelineNoPaging: { + type: "object", + properties: { + results: { + type: "array", + items: { + type: "ref", + ref: "Pipeline", + }, + }, + }, + required: ["results"], + }, + CollectionResponsePipelineStageNoPaging: { + type: "object", + properties: { + results: { + type: "array", + items: { + type: "ref", + ref: "PipelineStage", + }, + }, + }, + required: ["results"], + }, + CollectionResponsePublicAuditInfoNoPaging: { + type: "object", + properties: { + results: { + type: "array", + items: { + type: "ref", + ref: "PublicAuditInfo", + }, + }, + }, + required: ["results"], + }, + Pipeline: { + type: "object", + properties: { + archived: { + description: "Whether the pipeline is archived.", + type: "boolean", + }, + archivedAt: { + description: + "The date the pipeline was archived. `archivedAt` will only be present if the pipeline is archived.", + type: "string", + }, + createdAt: { + description: "The date the pipeline was created. The default pipelines will have createdAt = 0.", + type: "string", + }, + displayOrder: { + description: + "The order for displaying this pipeline. If two pipelines have a matching `displayOrder`, they will be sorted alphabetically by label.", + type: "integer", + format: "int32", + }, + id: { + description: "A unique identifier generated by HubSpot that can be used to retrieve and update the pipeline.", + type: "string", + }, + label: { + description: "A unique label used to organize pipelines in HubSpot's UI", + type: "string", + }, + stages: { + description: + "The stages associated with the pipeline. They can be retrieved and updated via the pipeline stages endpoints.", + type: "array", + items: { + type: "ref", + ref: "PipelineStage", + }, + }, + updatedAt: { + description: "The date the pipeline was last updated.", + type: "string", + }, + }, + required: ["archived", "createdAt", "displayOrder", "id", "label", "stages", "updatedAt"], + }, + PipelineInput: { + type: "object", + properties: { + displayOrder: { + description: + "The order for displaying this pipeline. If two pipelines have a matching `displayOrder`, they will be sorted alphabetically by label.", + type: "integer", + format: "int32", + }, + label: { + description: "A unique label used to organize pipelines in HubSpot's UI", + type: "string", + }, + pipelineId: { + type: "string", + }, + stages: { + description: "Pipeline stage inputs used to create the new or replacement pipeline.", + type: "array", + items: { + type: "ref", + ref: "PipelineStageInput", + }, + }, + }, + required: ["displayOrder", "label", "stages"], + }, + PipelinePatchInput: { + type: "object", + properties: { + archived: { + description: + "Whether the pipeline is archived. This property should only be provided when restoring an archived pipeline. If it's provided in any other call, the request will fail and a `400 Bad Request` will be returned.", + type: "boolean", + }, + displayOrder: { + description: + "The order for displaying this pipeline. If two pipelines have a matching `displayOrder`, they will be sorted alphabetically by label.", + type: "integer", + format: "int32", + }, + label: { + description: "A unique label used to organize pipelines in HubSpot's UI", + type: "string", + }, + }, + required: [], + }, + PipelineReplaceInput: { + type: "object", + properties: { + displayOrder: { + description: + "The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label.", + type: "integer", + format: "int32", + }, + label: { + description: + "A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.", + type: "string", + }, + stages: { + description: + "The stages associated with the pipeline. They can be retrieved and updated via the pipeline stages endpoints.", + type: "array", + items: { + type: "ref", + ref: "PipelineStageInput", + }, + }, + }, + required: ["displayOrder", "label", "stages"], + }, + PipelineStage: { + type: "object", + properties: { + archived: { + description: "Whether the pipeline is archived.", + type: "boolean", + }, + archivedAt: { + description: + "The date the pipeline was archived. `archivedAt` will only be present if the pipeline is archived.", + type: "string", + }, + createdAt: { + description: + "The date the pipeline stage was created. The stages on default pipelines will have createdAt = 0.", + type: "string", + }, + displayOrder: { + description: + "The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label.", + type: "integer", + format: "int32", + }, + id: { + description: + "A unique identifier generated by HubSpot that can be used to retrieve and update the pipeline stage.", + type: "string", + }, + label: { + description: + "A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.", + type: "string", + }, + metadata: { + description: + 'A JSON object containing properties that are not present on all object pipelines.\n\nFor `deals` pipelines, the `probability` field is required (`{ "probability": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1.\n\nFor `tickets` pipelines, the `ticketState` field is optional (`{ "ticketState": "OPEN" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`.', + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + updatedAt: { + description: "The date the pipeline stage was last updated.", + type: "string", + }, + writePermissions: { + description: + "Defines the level of write access for the pipeline stage, with possible values being CRM_PERMISSIONS_ENFORCEMENT, READ_ONLY, or INTERNAL_ONLY.", + type: "string", + enum: ["CRM_PERMISSIONS_ENFORCEMENT", "INTERNAL_ONLY", "READ_ONLY"], + }, + }, + required: ["archived", "createdAt", "displayOrder", "id", "label", "metadata", "updatedAt", "writePermissions"], + }, + PipelineStageInput: { + type: "object", + properties: { + displayOrder: { + description: + "The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label.", + type: "integer", + format: "int32", + }, + label: { + description: + "A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.", + type: "string", + }, + metadata: { + description: + 'A JSON object containing properties that are not present on all object pipelines.\n\nFor `deals` pipelines, the `probability` field is required (`{ "probability": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1.\n\nFor `tickets` pipelines, the `ticketState` field is optional (`{ "ticketState": "OPEN" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`.', + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + stageId: { + type: "string", + }, + }, + required: ["displayOrder", "label", "metadata"], + }, + PipelineStagePatchInput: { + type: "object", + properties: { + archived: { + description: "Whether the pipeline is archived.", + type: "boolean", + }, + displayOrder: { + description: + "The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label.", + type: "integer", + format: "int32", + }, + label: { + description: + "A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.", + type: "string", + }, + metadata: { + description: + 'A JSON object containing properties that are not present on all object pipelines.\n\nFor `deals` pipelines, the `probability` field is required (`{ "probability": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1.\n\nFor `tickets` pipelines, the `ticketState` field is optional (`{ "ticketState": "OPEN" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`.', + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + }, + required: ["metadata"], + }, + PipelineStageReplaceInput: { + type: "object", + properties: { + displayOrder: { + description: + "The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label.", + type: "integer", + format: "int32", + }, + label: { + description: + "A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.", + type: "string", + }, + metadata: { + description: + 'A JSON object containing properties that are not present on all object pipelines.\n\nFor `deals` pipelines, the `probability` field is required (`{ "probability": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1.\n\nFor `tickets` pipelines, the `ticketState` field is optional (`{ "ticketState": "OPEN" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`.', + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + }, + required: ["displayOrder", "label", "metadata"], + }, + PublicAuditInfo: { + type: "object", + properties: { + action: { + description: "The action performed that triggered the audit event.", + type: "string", + }, + fromUserId: { + description: "The ID of the user who initiated the audit event.", + type: "integer", + format: "int32", + }, + identifier: { + description: "A unique string identifier for the audit event.", + type: "string", + }, + message: { + description: "A descriptive message related to the audit event.", + type: "string", + }, + portalId: { + description: "The unique identifier for the HubSpot portal where the audit event occurred.", + type: "integer", + format: "int32", + }, + rawObject: { + description: "An object containing the raw data associated with the audit event.", + type: "object", + properties: {}, + required: [], + }, + timestamp: { + description: "The date and time when the audit event took place.", + type: "string", + }, + }, + required: ["action", "identifier", "portalId"], + }, + BatchInputPropertyCreate: { + type: "object", + properties: { + inputs: { + description: + "An array of PropertyCreate objects, each representing a property to be created. This field is required.", + type: "array", + items: { + type: "ref", + ref: "PropertyCreate", + }, + }, + }, + required: ["inputs"], + }, + BatchInputPropertyName: { + type: "object", + properties: { + inputs: { + description: + "An array of property names to be processed in the batch operation. Each item in the array is a reference to a PropertyName object.", + type: "array", + items: { + type: "ref", + ref: "PropertyName", + }, + }, + }, + required: ["inputs"], + }, + BatchReadInputPropertyName: { + type: "object", + properties: { + archived: { + description: "Specifies whether the property is archived.", + type: "boolean", + }, + dataSensitivity: { + description: + "Indicates the sensitivity level of the data, such as 'non_sensitive', 'sensitive', or 'highly_sensitive'.", + type: "string", + enum: ["highly_sensitive", "non_sensitive", "sensitive"], + }, + inputs: { + description: + "An array of property names to be included in the batch read operation. Each item in the array is a reference to a PropertyName object.", + type: "array", + items: { + type: "ref", + ref: "PropertyName", + }, + }, + }, + required: ["archived", "dataSensitivity", "inputs"], + }, + BatchResponseProperty: { + type: "object", + properties: { + completedAt: { + description: "The timestamp indicating when the batch operation was completed.", + type: "string", + }, + links: { + description: "A collection of URLs linking to documentation or resources related to the batch operation.", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + requestedAt: { + description: "The timestamp indicating when the batch operation was requested.", + type: "string", + }, + results: { + description: "An array of Property objects representing the results of the batch operation.", + type: "array", + items: { + type: "ref", + ref: "Property", + }, + }, + startedAt: { + description: "The timestamp indicating when the batch operation began processing.", + type: "string", + }, + status: { + description: + "The current status of the batch operation, with possible values being CANCELED, COMPLETE, PENDING, or PROCESSING.", + type: "string", + enum: ["CANCELED", "COMPLETE", "PENDING", "PROCESSING"], + }, + }, + required: ["completedAt", "results", "startedAt", "status"], + }, + BatchResponsePropertyWithErrors: { + type: "object", + properties: { + completedAt: { + description: "The date and time when the batch operation was completed, in ISO 8601 format.", + type: "string", + }, + errors: { + description: + "An array of errors encountered during the batch operation, each represented by a StandardError object.", + type: "array", + items: { + type: "ref", + ref: "StandardError", + }, + }, + links: { + description: + "A map of link names to their associated URIs, providing additional information or actions related to the batch operation.", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + numErrors: { + description: "The number of errors encountered during the batch operation.", + type: "integer", + format: "int32", + }, + requestedAt: { + description: "The date and time when the batch operation was requested, in ISO 8601 format.", + type: "string", + }, + results: { + description: "An array of properties that were processed in the batch operation.", + type: "array", + items: { + type: "ref", + ref: "Property", + }, + }, + startedAt: { + description: "The date and time when the batch operation started, in ISO 8601 format.", + type: "string", + }, + status: { + description: + "The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'.", + type: "string", + enum: ["CANCELED", "COMPLETE", "PENDING", "PROCESSING"], + }, + }, + required: ["completedAt", "results", "startedAt", "status"], + }, + CollectionResponsePropertyGroupNoPaging: { + type: "object", + properties: { + results: { + description: "An array of property groups, where each group is represented by a PropertyGroup object.", + type: "array", + items: { + type: "ref", + ref: "PropertyGroup", + }, + }, + }, + required: ["results"], + }, + CollectionResponsePropertyNoPaging: { + type: "object", + properties: { + results: { + description: + "An array of Property objects, each representing a specific property associated with the object type. This array contains the details of each property such as name, label, type, and other metadata.", + type: "array", + items: { + type: "ref", + ref: "Property", + }, + }, + }, + required: ["results"], + }, + Option: { + description: "A HubSpot property option", + type: "object", + properties: { + description: { + description: "A description of the option.", + type: "string", + }, + displayOrder: { + description: + "Options are displayed in order starting with the lowest positive integer value. Values of -1 will cause the option to be displayed after any positive values.", + type: "integer", + format: "int32", + }, + hidden: { + description: "Hidden options will not be displayed in HubSpot.", + type: "boolean", + }, + label: { + description: "A human-readable option label that will be shown in HubSpot.", + type: "string", + }, + value: { + description: + "The internal value of the option, which must be used when setting the property value through the API.", + type: "string", + }, + }, + required: ["hidden", "label", "value"], + }, + OptionInput: { + type: "object", + properties: { + description: { + description: "A description of the option.", + type: "string", + }, + displayOrder: { + description: + "Options are shown in order starting with the lowest positive integer value. Values of -1 will cause the option to be displayed after any positive values.", + type: "integer", + format: "int32", + }, + hidden: { + description: "Hidden options won't be shown in HubSpot.", + type: "boolean", + }, + label: { + description: "A human-readable option label that will be shown in HubSpot.", + type: "string", + }, + value: { + description: + "The internal value of the option, which must be used when setting the property value through the API.", + type: "string", + }, + }, + required: ["displayOrder", "hidden", "label", "value"], + }, + Property: { + description: "A HubSpot property", + type: "object", + properties: { + archived: { + description: "Whether or not the property is archived.", + type: "boolean", + }, + archivedAt: { + description: "When the property was archived.", + type: "string", + }, + calculated: { + description: + "For default properties, true indicates that the property is calculated by a HubSpot process. It has no effect for custom properties.", + type: "boolean", + }, + calculationFormula: { + description: "Represents a formula that is used to compute a calculated property.", + type: "string", + }, + createdAt: { + description: "The timestamp when the property was created, in ISO 8601 format.", + type: "string", + }, + createdUserId: { + description: + "The internal user ID of the user who created the property in HubSpot. This field may not exist if the property was created outside of HubSpot.", + type: "string", + }, + currencyPropertyName: { + description: "The name of the currency property associated with this property, if applicable.", + type: "string", + }, + dataSensitivity: { + description: + "The sensitivity level of the data. Valid values include 'non_sensitive', 'sensitive', and 'highly_sensitive'.", + type: "string", + enum: ["highly_sensitive", "non_sensitive", "sensitive"], + }, + dateDisplayHint: { + description: + "Indicates how date values should be displayed, with options such as 'absolute', 'absolute_with_relative', 'time_since', or 'time_until'.", + type: "string", + enum: ["absolute", "absolute_with_relative", "time_since", "time_until"], + }, + description: { + description: "A description of the property that will be shown as help text in HubSpot.", + type: "string", + }, + displayOrder: { + description: "Properties are shown in order, starting with the lowest positive integer value.", + type: "integer", + format: "int32", + }, + externalOptions: { + description: + "For default properties, true indicates that the options are stored externally to the property settings.", + type: "boolean", + }, + fieldType: { + description: "Controls how the property appears in HubSpot.", + type: "string", + }, + formField: { + description: "Whether or not the property can be used in a HubSpot form.", + type: "boolean", + }, + groupName: { + description: "The name of the property group the property belongs to.", + type: "string", + }, + hasUniqueValue: { + description: "Whether or not the property's value must be unique. Once set, this can't be changed.", + type: "boolean", + }, + hidden: { + description: + "Whether or not the property will be hidden from the HubSpot UI. It's recommended this be set to false for custom properties.", + type: "boolean", + }, + hubspotDefined: { + description: "This will be true for default object properties built into HubSpot.", + type: "boolean", + }, + label: { + description: "A human-readable property label that will be shown in HubSpot.", + type: "string", + }, + modificationMetadata: { + type: "ref", + ref: "PropertyModificationMetadata", + }, + name: { + description: "The internal property name, which must be used when referencing the property via the API.", + type: "string", + }, + numberDisplayHint: { + description: + "A hint for displaying number properties. Valid values include 'unformatted', 'formatted', 'currency', 'percentage', 'duration', and 'probability'.", + type: "string", + enum: ["currency", "duration", "formatted", "percentage", "probability", "unformatted"], + }, + options: { + description: + "A list of valid options for the property. This field is required for enumerated properties, but will be empty for other property types.", + type: "array", + items: { + type: "ref", + ref: "Option", + }, + }, + referencedObjectType: { + description: "If this property is related to other object(s), they'll be listed here.", + type: "string", + }, + sensitiveDataCategories: { + description: "An array of categories indicating the sensitivity of the data contained in the property.", + type: "array", + items: { + type: "string", + }, + }, + showCurrencySymbol: { + description: "Whether or not the property will display the currency symbol set in the account settings.", + type: "boolean", + }, + textDisplayHint: { + description: + "A hint for displaying text properties. Valid values include 'unformatted_single_line', 'multi_line', 'email', 'phone_number', 'domain_name', 'ip_address', 'physical_address', and 'postal_code'.", + type: "string", + enum: [ + "domain_name", + "email", + "ip_address", + "multi_line", + "phone_number", + "physical_address", + "postal_code", + "unformatted_single_line", + ], + }, + type: { + description: "The property data type.", + type: "string", + }, + updatedAt: { + description: "The timestamp when the property was last updated, in ISO 8601 format.", + type: "string", + }, + updatedUserId: { + description: + "The internal user ID of the user who updated the property in HubSpot. This field may not exist if the property was updated outside of HubSpot.", + type: "string", + }, + }, + required: ["description", "fieldType", "groupName", "label", "name", "options", "type"], + }, + PropertyCreate: { + type: "object", + properties: { + calculationFormula: { + description: "Represents a formula that is used to compute a calculated property.", + type: "string", + }, + currencyPropertyName: { + description: "A string representing the name of the currency property.", + type: "string", + }, + dataSensitivity: { + description: + "Indicates the sensitivity level of the property, with options: highly_sensitive, non_sensitive, or sensitive.", + type: "string", + enum: ["highly_sensitive", "non_sensitive", "sensitive"], + }, + description: { + description: "A description of the property that will be shown as help text in HubSpot.", + type: "string", + }, + displayOrder: { + description: + "Properties are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property to be displayed after any positive values.", + type: "integer", + format: "int32", + }, + externalOptions: { + description: + "Applicable only for 'enumeration' type properties. Should be set to true in conjunction with a 'referencedObjectType' of 'OWNER'. Otherwise false.", + type: "boolean", + }, + fieldType: { + description: "Controls how the property appears in HubSpot.", + type: "string", + enum: [ + "booleancheckbox", + "calculation_equation", + "checkbox", + "date", + "file", + "html", + "number", + "phonenumber", + "radio", + "select", + "text", + "textarea", + ], + }, + formField: { + description: "Whether or not the property can be used in a HubSpot form.", + type: "boolean", + }, + groupName: { + description: "The name of the property group the property belongs to.", + type: "string", + }, + hasUniqueValue: { + description: "Whether or not the property's value must be unique. Once set, this can't be changed.", + type: "boolean", + }, + hidden: { + description: "If true, the property won't be visible and can't be used in HubSpot.", + type: "boolean", + }, + label: { + description: "A human-readable property label that will be shown in HubSpot.", + type: "string", + }, + name: { + description: "The internal property name, which must be used when referencing the property via the API.", + type: "string", + }, + numberDisplayHint: { + description: + "A string providing a hint on how to display numbers. Valid values include 'unformatted', 'formatted', 'currency', 'percentage', 'duration', 'probability'.", + type: "string", + enum: ["currency", "duration", "formatted", "percentage", "probability", "unformatted"], + }, + options: { + description: "A list of valid options for the property. This field is required for enumerated properties.", + type: "array", + items: { + type: "ref", + ref: "OptionInput", + }, + }, + referencedObjectType: { + description: + "Should be set to 'OWNER' when 'externalOptions' is true, which causes the property to dynamically pull option values from the current HubSpot users.", + type: "string", + }, + showCurrencySymbol: { + description: "A boolean indicating whether to show the currency symbol for currency fields.", + type: "boolean", + }, + textDisplayHint: { + description: + "A string providing a hint on how to display text. Valid values include 'unformatted_single_line', 'multi_line', 'email', 'phone_number', 'domain_name', 'ip_address', 'physical_address', 'postal_code'.", + type: "string", + enum: [ + "domain_name", + "email", + "ip_address", + "multi_line", + "phone_number", + "physical_address", + "postal_code", + "unformatted_single_line", + ], + }, + type: { + description: "The data type of the property.", + type: "string", + enum: ["bool", "date", "datetime", "enumeration", "number", "phone_number", "string"], + }, + }, + required: ["fieldType", "groupName", "label", "name", "type"], + }, + PropertyGroup: { + type: "object", + properties: { + archived: { + description: "Indicates whether the property group is archived.", + type: "boolean", + }, + displayOrder: { + description: + "Property groups are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property group to be displayed after any positive values.", + type: "integer", + format: "int32", + }, + label: { + description: "A human-readable label that will be shown in HubSpot.", + type: "string", + }, + name: { + description: + "The internal property group name, which must be used when referencing the property group via the API.", + type: "string", + }, + }, + required: ["archived", "label", "name"], + }, + PropertyGroupCreate: { + type: "object", + properties: { + displayOrder: { + description: + "Property groups are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property group to be displayed after any positive values.", + type: "integer", + format: "int32", + }, + label: { + description: "A human-readable label that will be shown in HubSpot.", + type: "string", + }, + name: { + description: + "The internal property group name, which must be used when referencing the property group via the API.", + type: "string", + }, + }, + required: ["label", "name"], + }, + PropertyGroupUpdate: { + type: "object", + properties: { + displayOrder: { + description: + "Property groups are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property group to be displayed after any positive values.", + type: "integer", + format: "int32", + }, + label: { + description: "A human-readable label that will be shown in HubSpot.", + type: "string", + }, + }, + required: [], + }, + PropertyModificationMetadata: { + type: "object", + properties: { + archivable: { + description: "Specifies whether the property can be archived.", + type: "boolean", + }, + readOnlyDefinition: { + description: "Indicates whether the property's definition is read-only and cannot be modified.", + type: "boolean", + }, + readOnlyOptions: { + description: "Indicates whether the property's options are read-only and cannot be modified.", + type: "boolean", + }, + readOnlyValue: { + description: "Indicates whether the property's value is read-only and cannot be modified.", + type: "boolean", + }, + }, + required: ["archivable", "readOnlyDefinition", "readOnlyValue"], + }, + PropertyName: { + type: "object", + properties: { + name: { + description: "The name of the property to read or modify.", + type: "string", + }, + }, + required: ["name"], + }, + PropertyUpdate: { + type: "object", + properties: { + calculationFormula: { + description: "Represents a formula that is used to compute a calculated property.", + type: "string", + }, + currencyPropertyName: { + description: + "A string specifying the name of the property that holds the currency information, applicable when showCurrencySymbol is true.", + type: "string", + }, + description: { + description: "A description of the property that will be shown as help text in HubSpot.", + type: "string", + }, + displayOrder: { + description: + "Properties are displayed in order starting with the lowest positive integer value. Values of -1 will cause the Property to be displayed after any positive values.", + type: "integer", + format: "int32", + }, + fieldType: { + description: "Controls how the property appears in HubSpot.", + type: "string", + enum: [ + "booleancheckbox", + "calculation_equation", + "checkbox", + "date", + "file", + "html", + "number", + "phonenumber", + "radio", + "select", + "text", + "textarea", + ], + }, + formField: { + description: "Whether or not the property can be used in a HubSpot form.", + type: "boolean", + }, + groupName: { + description: "The name of the property group the property belongs to.", + type: "string", + }, + hidden: { + description: "If true, the property won't be visible and can't be used in HubSpot.", + type: "boolean", + }, + label: { + description: "A human-readable property label that will be shown in HubSpot.", + type: "string", + }, + numberDisplayHint: { + description: + "A string providing a hint for displaying number values. Valid values include 'unformatted', 'formatted', 'currency', 'percentage', 'duration', and 'probability'.", + type: "string", + enum: ["currency", "duration", "formatted", "percentage", "probability", "unformatted"], + }, + options: { + description: "A list of valid options for the property.", + type: "array", + items: { + type: "ref", + ref: "OptionInput", + }, + }, + showCurrencySymbol: { + description: + "A boolean indicating whether to display a currency symbol for number fields formatted as currency.", + type: "boolean", + }, + textDisplayHint: { + description: + "A string providing a hint for displaying text values. Valid values include 'unformatted_single_line', 'multi_line', 'email', 'phone_number', 'domain_name', 'ip_address', 'physical_address', and 'postal_code'.", + type: "string", + enum: [ + "domain_name", + "email", + "ip_address", + "multi_line", + "phone_number", + "physical_address", + "postal_code", + "unformatted_single_line", + ], + }, + type: { + description: "The data type of the property.", + type: "string", + enum: ["bool", "date", "datetime", "enumeration", "number", "phone_number", "string"], + }, + }, + required: [], + }, + AssociationSpecWithLabel: { + description: "Defines the type, direction, and details of the relationship between two CRM objects.", + type: "object", + properties: { + category: { + description: "The category of the association, such as HUBSPOT_DEFINED, USER_DEFINED, or INTEGRATOR_DEFINED.", + type: "string", + enum: ["HUBSPOT_DEFINED", "INTEGRATOR_DEFINED", "USER_DEFINED", "WORK"], + }, + fromObjectTypeId: { + type: "string", + }, + label: { + description: "A label describing the association between two objects.", + type: "string", + }, + toObjectTypeId: { + type: "string", + }, + typeId: { + description: "The unique identifier for the type of association.", + type: "integer", + format: "int32", + }, + }, + required: ["category", "typeId"], + }, + BatchInputPublicAssociationMultiArchive: { + type: "object", + properties: { + inputs: { + type: "array", + items: { + type: "ref", + ref: "PublicAssociationMultiArchive", + }, + }, + }, + required: ["inputs"], + }, + BatchInputPublicAssociationMultiPost: { + type: "object", + properties: { + inputs: { + type: "array", + items: { + type: "ref", + ref: "PublicAssociationMultiPost", + }, + }, + }, + required: ["inputs"], + }, + BatchInputPublicDefaultAssociationMultiPost: { + type: "object", + properties: { + inputs: { + type: "array", + items: { + type: "ref", + ref: "PublicDefaultAssociationMultiPost", + }, + }, + }, + required: ["inputs"], + }, + BatchInputPublicFetchAssociationsBatchRequest: { + type: "object", + properties: { + inputs: { + type: "array", + items: { + type: "ref", + ref: "PublicFetchAssociationsBatchRequest", + }, + }, + }, + required: ["inputs"], + }, + BatchResponse: { + type: "object", + properties: { + completedAt: { + type: "string", + }, + errors: { + type: "array", + items: { + type: "ref", + ref: "StandardError", + }, + }, + links: { + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + numErrors: { + type: "integer", + format: "int32", + }, + requestedAt: { + type: "string", + }, + results: { + type: "array", + items: { + type: "object", + properties: {}, + required: [], + }, + }, + startedAt: { + type: "string", + }, + status: { type: "string", - minLength: 1, + enum: ["CANCELED", "COMPLETE", "PENDING", "PROCESSING"], }, }, - required: ["text"], + required: ["completedAt", "results", "startedAt", "status"], }, - Comment: { + BatchResponseLabelsBetweenObjectPair: { type: "object", properties: { - id: { + completedAt: { + description: "The timestamp when the batch processing was completed, in ISO 8601 format.", + type: "string", + }, + links: { + description: "An object containing relevant links related to the batch request.", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + requestedAt: { + description: "The timestamp when the batch request was initially made, in ISO 8601 format.", + type: "string", + }, + results: { + type: "array", + items: { + type: "ref", + ref: "LabelsBetweenObjectPair", + }, + }, + startedAt: { + description: "The timestamp when the batch processing began, in ISO 8601 format.", + type: "string", + }, + status: { + description: 'The status of the batch processing request: "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE".', + type: "string", + enum: ["CANCELED", "COMPLETE", "PENDING", "PROCESSING"], + }, + }, + required: ["completedAt", "results", "startedAt", "status"], + }, + BatchResponseLabelsBetweenObjectPairWithErrors: { + type: "object", + properties: { + completedAt: { + type: "string", + }, + errors: { + type: "array", + items: { + type: "ref", + ref: "StandardError", + }, + }, + links: { + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + numErrors: { + type: "integer", + format: "int32", + }, + requestedAt: { + type: "string", + }, + results: { + type: "array", + items: { + type: "ref", + ref: "LabelsBetweenObjectPair", + }, + }, + startedAt: { + type: "string", + }, + status: { + type: "string", + enum: ["CANCELED", "COMPLETE", "PENDING", "PROCESSING"], + }, + }, + required: ["completedAt", "results", "startedAt", "status"], + }, + BatchResponsePublicAssociationMultiWithLabel: { + type: "object", + properties: { + completedAt: { + description: "The timestamp when the batch processing was completed, in ISO 8601 format.", type: "string", }, - text: { + links: { + description: "An object containing relevant links related to the batch request.", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + requestedAt: { + description: "The timestamp when the batch request was initially made, in ISO 8601 format.", + type: "string", + }, + results: { + type: "array", + items: { + type: "ref", + ref: "PublicAssociationMultiWithLabel", + }, + }, + startedAt: { + description: "The timestamp when the batch processing began, in ISO 8601 format.", + type: "string", + }, + status: { + description: 'The status of the batch processing request: "PENDING", "PROCESSING", "CANCELED", or "COMPLETE".', + type: "string", + enum: ["CANCELED", "COMPLETE", "PENDING", "PROCESSING"], + }, + }, + required: ["completedAt", "results", "startedAt", "status"], + }, + BatchResponsePublicAssociationMultiWithLabelWithErrors: { + type: "object", + properties: { + completedAt: { + type: "string", + }, + errors: { + type: "array", + items: { + type: "ref", + ref: "StandardError", + }, + }, + links: { + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + numErrors: { + type: "integer", + format: "int32", + }, + requestedAt: { + type: "string", + }, + results: { + type: "array", + items: { + type: "ref", + ref: "PublicAssociationMultiWithLabel", + }, + }, + startedAt: { + type: "string", + }, + status: { + type: "string", + enum: ["CANCELED", "COMPLETE", "PENDING", "PROCESSING"], + }, + }, + required: ["completedAt", "results", "startedAt", "status"], + }, + AssociationsBatchResponsePublicDefaultAssociation: { + description: "The response returned after performing a batch operation on associations.", + type: "object", + properties: { + completedAt: { + description: "The timestamp when the batch process was completed, in ISO 8601 format.", + type: "string", + }, + errors: { + description: "An array of StandardError objects detailing any errors that occurred during the batch operation.", + type: "array", + items: { + type: "ref", + ref: "StandardError", + }, + }, + links: { + description: "An object containing relevant links related to the batch request.", + type: "object", + properties: {}, + required: [], + additionalProperties: { + type: "string", + }, + }, + numErrors: { + description: "The number of errors encountered during the batch processing.", + type: "integer", + format: "int32", + }, + requestedAt: { + description: "The timestamp when the batch process was initiated, in ISO 8601 format.", type: "string", }, - author: { + results: { + description: "An array of PublicDefaultAssociation objects representing the results of the batch operation.", + type: "array", + items: { + type: "ref", + ref: "PublicDefaultAssociation_1", + }, + }, + startedAt: { + description: "The timestamp when the batch process began execution, in ISO 8601 format.", type: "string", }, - created_at: { + status: { + description: 'The status of the batch processing request: "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE".', type: "string", + enum: ["CANCELED", "COMPLETE", "PENDING", "PROCESSING"], }, }, - required: ["id", "text", "author", "created_at"], + required: ["completedAt", "results", "startedAt", "status"], }, - CommentList: { + CollectionResponseMultiAssociatedObjectWithLabelForwardPaging: { + description: + "Represents a paginated collection of objects that are associated with multiple labels, including the results and pagination details. This component is used when retrieving associated objects with specific labels in a forward-paging manner.", type: "object", properties: { + paging: { + type: "ref", + ref: "ForwardPaging", + }, results: { + description: + "The list of objects that are associated with multiple labels, returned as part of the collection.", type: "array", items: { type: "ref", - ref: "Comment", + ref: "MultiAssociatedObjectWithLabel", }, }, - has_more: { + }, + required: ["results"], + }, + DateTime: { + type: "object", + properties: { + dateOnly: { + description: "Indicates whether the DateTime value represents only a date without a time component.", type: "boolean", }, - next_cursor: { - nullable: true, + timeZoneShift: { + description: "The integer value representing the shift in minutes from UTC for the DateTime value.", + type: "integer", + format: "int32", + }, + value: { + description: "The integer value representing a specific point in time.", + type: "integer", + format: "int64", + }, + }, + required: ["dateOnly", "timeZoneShift", "value"], + }, + MultiAssociatedObjectWithLabel: { + description: "Represents an object that is associated with multiple other objects, with optional context.", + type: "object", + properties: { + associationTypes: { + description: + "An array of association types that define the relationships between this object and other objects. This property is required.", + type: "array", + items: { + type: "ref", + ref: "AssociationSpecWithLabel", + }, + }, + toObjectId: { + description: "The unique identifier for the target object in the association.", + type: "string", + }, + }, + required: ["associationTypes", "toObjectId"], + }, + Paging1: { + description: + "Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.", + type: "object", + properties: { + next: { + type: "ref", + ref: "NextPage", + }, + prev: { + type: "ref", + ref: "PreviousPage", + }, + }, + required: [], + }, + PublicAssociationMultiArchive: { + type: "object", + properties: { + from: { + type: "ref", + ref: "PublicObjectId", + }, + to: { + type: "array", + items: { + type: "ref", + ref: "PublicObjectId", + }, + }, + }, + required: ["from", "to"], + }, + PublicAssociationMultiPost: { + type: "object", + properties: { + from: { + type: "ref", + ref: "PublicObjectId", + }, + to: { + type: "ref", + ref: "PublicObjectId", + }, + types: { + type: "array", + items: { + type: "ref", + ref: "AssociationSpec", + }, + }, + }, + required: ["from", "to", "types"], + }, + PublicAssociationMultiWithLabel: { + type: "object", + properties: { + from: { + type: "ref", + ref: "PublicObjectId", + }, + paging: { + type: "ref", + ref: "Paging_1", + }, + to: { + type: "array", + items: { + type: "ref", + ref: "MultiAssociatedObjectWithLabel", + }, + }, + }, + required: ["from", "to"], + }, + PublicDefaultAssociationMultiPost: { + type: "object", + properties: { + from: { + type: "ref", + ref: "PublicObjectId", + }, + to: { + type: "ref", + ref: "PublicObjectId", + }, + }, + required: ["from", "to"], + }, + PublicDefaultAssociation1: { + description: + "The PublicDefaultAssociation component represents the default association configuration between two objects in HubSpot. It is used to define how objects are related to each other within the platform.", + type: "object", + properties: { + associationSpec: { + type: "ref", + ref: "AssociationSpec", + }, + from: { + type: "ref", + ref: "PublicObjectId", + }, + to: { + type: "ref", + ref: "PublicObjectId", + }, + }, + required: ["associationSpec", "from", "to"], + }, + PublicFetchAssociationsBatchRequest: { + type: "object", + properties: { + after: { + description: "A paging cursor token used to retrieve the next set of results in a paginated response.", + type: "string", + }, + id: { + description: "The unique identifier for the object whose associations are being fetched.", + type: "string", + }, + }, + required: ["id"], + }, + ReportCreationResponse: { + type: "object", + properties: { + enqueueTime: { + type: "ref", + ref: "DateTime", + }, + userEmail: { + description: "Email of the user", + type: "string", + }, + userId: { + description: "ID of the user", + type: "integer", + format: "int32", + }, + }, + required: ["enqueueTime", "userEmail", "userId"], + }, + ApiUsage: { + type: "object", + properties: { + collectedAt: { + description: "Indicates when the cache was last updated.", + type: "string", + }, + currentUsage: { + description: "How many API calls an account has made for the current day.", + type: "integer", + format: "int32", + }, + fetchStatus: { + description: "Status of fetching the information, including if the data came from the cache.", + type: "string", + enum: ["CACHED", "FAILURE", "NOTFOUND", "SUCCESS", "TIMEOUT"], + }, + name: { + description: "Name of the limit type.", + type: "string", + }, + resetsAt: { + description: "Time that the limit will reset.", + type: "string", + }, + usageLimit: { + description: "Limits by which a single integration can consume the HubSpot public APIs.", + type: "integer", + format: "int32", + }, + }, + required: ["collectedAt", "currentUsage", "fetchStatus", "name", "usageLimit"], + }, + CollectionResponseApiUsageNoPaging: { + type: "object", + properties: { + results: { + type: "array", + items: { + type: "ref", + ref: "ApiUsage", + }, + }, + }, + required: ["results"], + }, + PortalInformationResponse: { + type: "object", + properties: { + accountType: { + description: "The type of account, such as APP_DEVELOPER, DEVELOPER_TEST, SANDBOX, or STANDARD.", + type: "string", + enum: ["APP_DEVELOPER", "DEVELOPER_TEST", "SANDBOX", "STANDARD"], + }, + additionalCurrencies: { + type: "array", + items: { + type: "string", + }, + }, + companyCurrency: { + description: "The primary currency used by the company.", + type: "string", + }, + dataHostingLocation: { + description: "The location where the account's data is hosted.", + type: "string", + }, + portalId: { + description: "The unique identifier for the HubSpot account.", + type: "integer", + format: "int32", + }, + timeZone: { + description: "The time zone in which the account operates.", + type: "string", + }, + uiDomain: { + description: "The domain used for accessing the HubSpot user interface.", + type: "string", + }, + utcOffset: { + description: "The time zone offset from UTC in hours and minutes.", type: "string", }, + utcOffsetMilliseconds: { + description: "The time zone offset from UTC in milliseconds.", + type: "integer", + format: "int64", + }, }, - required: ["results", "has_more"], + required: [ + "accountType", + "additionalCurrencies", + "companyCurrency", + "dataHostingLocation", + "portalId", + "timeZone", + "uiDomain", + "utcOffset", + "utcOffsetMilliseconds", + ], }, + PutCrmObjects202603ObjectTypeObjectIdAssociationsToObjectTypeToObjectIdCrmObjects202603ObjectTypeObjectIdAssociationsToObjectTypeToObjectIdRequest: + { + type: "array", + items: { + type: "ref", + ref: "AssociationSpec", + }, + }, } diff --git a/src/generated/manifest.ts b/src/generated/manifest.ts index 01a2f72..7915143 100644 --- a/src/generated/manifest.ts +++ b/src/generated/manifest.ts @@ -6,173 +6,6675 @@ import type { ApiServer, ManifestOperation, SecurityRequirement, SecurityScheme export const operations: readonly ManifestOperation[] = [ { - id: "listComments", - command: "comments-list", + id: "get-/crm/objects/2026-03/contacts_getPage", + command: "contacts-list", binding: { kind: "http", method: "GET", - path: "/comments", + path: "/crm/objects/2026-03/contacts", }, effect: "read", - summary: "List comments, newest first", - tags: ["Comments"], + summary: "Retrieve contacts", + description: "Retrieve all contacts, using query parameters to specify the information that gets returned.", + tags: ["Basic"], + security: [], pagination: { style: "cursor", cursor: { in: "query", - name: "start_cursor", + name: "after", }, - next: "next_cursor", + next: "paging.next.after", items: "results", - hasMore: "has_more", limit: { in: "query", name: "limit", }, }, parameters: [ + { + name: "after", + in: "query", + required: false, + schema: { + type: "string", + }, + description: + "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", + }, + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + { + name: "associations", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + }, { name: "limit", in: "query", required: false, schema: { + default: 10, type: "integer", - minimum: 1, - maximum: 100, + format: "int32", }, + description: "The maximum number of results to display per page.", }, { - name: "start_cursor", + name: "properties", in: "query", required: false, schema: { - type: "string", + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + { + name: "propertiesWithHistory", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.", + }, + ], + response: { + confidence: "contract", + schema: "CollectionResponseSimplePublicObjectWithAssociationsForwardPaging", + }, + }, + { + id: "post-/crm/objects/2026-03/contacts_create", + command: "contacts-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/contacts", + }, + effect: "write", + summary: "Create a contact", + description: + "Create a single contact. Include a `properties` object to define [property values](https://developers.hubspot.com/docs/guides/api/crm/properties) for the contact, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.", + tags: ["Basic"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "SimplePublicObjectInputForCreate", + }, + response: { + confidence: "contract", + schema: "SimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/contacts/batch/archive_archive", + command: "contacts-batch-archive", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/contacts/batch/archive", + }, + effect: "destructive", + summary: "Archive a batch of contacts", + description: + "Archive a batch of contacts by ID. Archived contacts can be restored within 90 days of deletion. Learn more about the [data impacted by contact deletions](https://knowledge.hubspot.com/privacy-and-consent/understand-restorable-and-permanent-contact-deletions) and how to [restore archived records](https://knowledge.hubspot.com/records/restore-deleted-records).", + tags: ["Batch"], + security: [], + permissions: [ + { + key: "people.delete", + }, + ], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectId", + }, + }, + { + id: "post-/crm/objects/2026-03/contacts/batch/create_create", + command: "contacts-batch-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/contacts/batch/create", + }, + effect: "write", + summary: "Create a batch of contacts", + description: + "Create a batch of contacts. The `inputs` array can contain a `properties` object to define property values for each record, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInputForCreate", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/contacts/batch/read_read", + command: "contacts-batch-read", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/contacts/batch/read", + }, + effect: "write", + summary: "Retrieve a batch of contacts", + description: "Retrieve a batch of contacts by ID (`contactId`) or unique property value (`idProperty`). ", + tags: ["Batch"], + security: [], + parameters: [ + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", }, + description: "Whether to return only results that have been archived.", }, ], + request: { + required: true, + confidence: "contract", + schema: "BatchReadInputSimplePublicObjectId", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/contacts/batch/update_update", + command: "contacts-batch-update", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/contacts/batch/update", + }, + effect: "write", + summary: "Update a batch of contacts", + description: + "Update a batch of contacts by ID (`contactId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInput", + }, response: { confidence: "contract", - schema: "CommentList", + schema: "BatchResponseSimplePublicObject", }, }, { - id: "createComment", - command: "comments-create", + id: "post-/crm/objects/2026-03/contacts/batch/upsert_upsert", + command: "contacts-batch-upsert", binding: { kind: "http", method: "POST", - path: "/comments", + path: "/crm/objects/2026-03/contacts/batch/upsert", }, effect: "write", - summary: "Create a comment", - tags: ["Comments"], + summary: "Create or update a batch of contacts", + description: + "Upsert a batch of contacts. The `inputs` array can contain a `properties` object to define property values for each record.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInputUpsert", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicUpsertObject", + }, + }, + { + id: "post-/crm/objects/2026-03/contacts/gdpr-delete_purge", + command: "contacts-gdpr-delete", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/contacts/gdpr-delete", + }, + effect: "destructive", + summary: "Permanently delete a contact (GDPR-compliant)", + description: + "Permanently delete a contact and all associated content to follow GDPR. Use optional property `idProperty` set to `email` to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future. Learn more about [permanently deleting contacts](https://knowledge.hubspot.com/privacy-and-consent/how-do-i-perform-a-gdpr-delete-in-hubspot).", + tags: ["Advanced"], + security: [], + permissions: [ + { + key: "people.delete", + }, + ], parameters: [], request: { required: true, confidence: "contract", - schema: "NewComment", + schema: "PublicGdprDeleteInput", + }, + }, + { + id: "post-/crm/objects/2026-03/contacts/merge_merge", + command: "contacts-merge", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/contacts/merge", + }, + effect: "destructive", + summary: "Merge two contacts", + description: + "Merge two contact records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records). ", + tags: ["Advanced"], + security: [], + permissions: [ + { + key: "people.delete", + }, + ], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "PublicMergeInput", + }, + response: { + confidence: "contract", + schema: "SimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/contacts/search_doSearch", + command: "contacts-search", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/contacts/search", + }, + effect: "read", + summary: "Search for contacts", + description: + "Search for contacts by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).", + tags: ["Search"], + security: [], + pagination: { + style: "cursor", + cursor: { + in: "body", + name: "after", + }, + next: "paging.next.after", + items: "results", + limit: { + in: "body", + name: "limit", + }, + }, + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "PublicObjectSearchRequest", }, response: { confidence: "contract", - schema: "Comment", + schema: "CollectionResponseWithTotalSimplePublicObject", }, }, { - id: "getComment", - command: "comments-get", + id: "get-/crm/objects/2026-03/contacts/{contactId}_getById", + command: "contacts-get", binding: { kind: "http", method: "GET", - path: "/comments/{comment_id}", + path: "/crm/objects/2026-03/contacts/{contactId}", }, effect: "read", - summary: "Show one comment", - tags: ["Comments"], + summary: "Retrieve a contact", + description: + "Retrieve a contact by its ID (`contactId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter.", + tags: ["Basic"], + security: [], parameters: [ { - name: "comment_id", + name: "contactId", in: "path", required: true, schema: { type: "string", + pattern: ".+", + }, + }, + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + { + name: "associations", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + }, + { + name: "idProperty", + in: "query", + required: false, + schema: { + type: "string", + }, + description: "The name of a property whose values are unique for this object type", + }, + { + name: "properties", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + { + name: "propertiesWithHistory", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, }, + description: + "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.", }, ], response: { confidence: "contract", - schema: "Comment", + schema: "SimplePublicObjectWithAssociations", }, }, { - id: "updateComment", - command: "comments-update", + id: "patch-/crm/objects/2026-03/contacts/{contactId}_update", + command: "contacts-update", binding: { kind: "http", method: "PATCH", - path: "/comments/{comment_id}", + path: "/crm/objects/2026-03/contacts/{contactId}", }, effect: "write", - summary: "Change a comment's text", - tags: ["Comments"], + summary: "Update a contact", + description: + "Update an existing contact, identified by ID or email/unique property value. To identify a contact by ID, include the ID in the request URL path. To identify a contact by their email or other unique property, include the email/property value in the request URL path, and add the `idProperty` query parameter (`/crm/v3/objects/contacts/jon@website.com?idProperty=email`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + tags: ["Basic"], + security: [], parameters: [ { - name: "comment_id", + name: "contactId", in: "path", required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + { + name: "idProperty", + in: "query", + required: false, schema: { type: "string", }, + description: "The name of a property whose values are unique for this object type", }, ], request: { required: true, confidence: "contract", - schema: "NewComment", + schema: "SimplePublicObjectInput", }, response: { confidence: "contract", - schema: "Comment", + schema: "SimplePublicObject", }, }, { - id: "deleteComment", - command: "comments-delete", + id: "delete-/crm/objects/2026-03/contacts/{contactId}_archive", + command: "contacts-delete", binding: { kind: "http", method: "DELETE", - path: "/comments/{comment_id}", + path: "/crm/objects/2026-03/contacts/{contactId}", }, effect: "destructive", - summary: "Delete a comment", - tags: ["Comments"], + summary: "Archive a contact", + description: + "Delete a contact by ID. Deleted contacts can be restored within 90 days of deletion. Learn more about the [data impacted by contact deletions](https://knowledge.hubspot.com/privacy-and-consent/understand-restorable-and-permanent-contact-deletions) and how to [restore archived records](https://knowledge.hubspot.com/records/restore-deleted-records).", + tags: ["Basic"], + security: [], permissions: [ { - key: "comments.delete", + key: "people.delete", }, ], parameters: [ { - name: "comment_id", + name: "contactId", in: "path", required: true, schema: { type: "string", + pattern: ".+", }, }, ], }, -] - -export const servers: readonly ApiServer[] = [ { - url: "https://comments.example.invalid/v1", + id: "put-/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}", + command: "associations-default-replace", + binding: { + kind: "http", + method: "PUT", + path: "/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}", + }, + effect: "write", + summary: "", + description: "", + tags: ["Batch"], + parameters: [ + { + name: "fromObjectId", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "fromObjectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "toObjectId", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "toObjectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + ], + response: { + confidence: "contract", + schema: "BatchResponsePublicDefaultAssociation", + }, }, -] - -export const securitySchemes: Readonly> = { - token: { - scheme: "bearer", - type: "http", + { + id: "put-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + command: "associations-replace", + binding: { + kind: "http", + method: "PUT", + path: "/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + }, + effect: "write", + summary: "", + description: "", + tags: ["Basic"], + parameters: [ + { + name: "objectId", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "toObjectId", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "toObjectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + ], + request: { + required: true, + confidence: "contract", + schema: + "PutCrmObjects202603ObjectTypeObjectIdAssociationsToObjectTypeToObjectIdCrmObjects202603ObjectTypeObjectIdAssociationsToObjectTypeToObjectIdRequest", + }, + response: { + confidence: "contract", + schema: "LabelsBetweenObjectPair", + }, + }, + { + id: "delete-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + command: "associations-delete", + binding: { + kind: "http", + method: "DELETE", + path: "/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", + }, + effect: "destructive", + summary: "", + description: "", + tags: ["Basic"], + permissions: [ + { + key: "associations.delete", + }, + ], + parameters: [ + { + name: "objectId", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "toObjectId", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "toObjectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + ], + }, + { + id: "get-/crm/objects/2026-03/companies_getPage", + command: "companies-list", + binding: { + kind: "http", + method: "GET", + path: "/crm/objects/2026-03/companies", + }, + effect: "read", + summary: "Retrieve companies", + description: "Retrieve all companies, using query parameters to control the information that gets returned.", + tags: ["Basic"], + security: [], + pagination: { + style: "cursor", + cursor: { + in: "query", + name: "after", + }, + next: "paging.next.after", + items: "results", + limit: { + in: "query", + name: "limit", + }, + }, + parameters: [ + { + name: "after", + in: "query", + required: false, + schema: { + type: "string", + }, + description: + "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", + }, + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + { + name: "associations", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + }, + { + name: "limit", + in: "query", + required: false, + schema: { + default: 10, + type: "integer", + format: "int32", + }, + description: "The maximum number of results to display per page.", + }, + { + name: "properties", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + { + name: "propertiesWithHistory", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.", + }, + ], + response: { + confidence: "contract", + schema: "CollectionResponseSimplePublicObjectWithAssociationsForwardPaging", + }, + }, + { + id: "post-/crm/objects/2026-03/companies_create", + command: "companies-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/companies", + }, + effect: "write", + summary: "Create a company", + description: + "Create a single company. Include a `properties` object to define [property values](https://developers.hubspot.com/docs/guides/api/crm/properties) for the company, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.", + tags: ["Basic"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "SimplePublicObjectInputForCreate", + }, + response: { + confidence: "contract", + schema: "SimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/companies/batch/archive_archive", + command: "companies-batch-archive", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/companies/batch/archive", + }, + effect: "destructive", + summary: "Archive a batch of companies", + description: + "Delete a batch of companies by ID. Deleted companies can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).", + tags: ["Batch"], + security: [], + permissions: [ + { + key: "organizations.delete", + }, + ], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectId", + }, + }, + { + id: "post-/crm/objects/2026-03/companies/batch/create_create", + command: "companies-batch-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/companies/batch/create", + }, + effect: "write", + summary: "Create a batch of companies", + description: + "Create a batch of companies. The `inputs` array can contain a `properties` object to define property values for each company, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInputForCreate", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/companies/batch/read_read", + command: "companies-batch-read", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/companies/batch/read", + }, + effect: "write", + summary: "Retrieve a batch of companies", + description: + "Retrieve a batch of companies by ID (`companyId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter.", + tags: ["Batch"], + security: [], + parameters: [ + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + ], + request: { + required: true, + confidence: "contract", + schema: "BatchReadInputSimplePublicObjectId", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/companies/batch/update_update", + command: "companies-batch-update", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/companies/batch/update", + }, + effect: "write", + summary: "Update a batch of companies", + description: "Update a batch of companies by ID.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInput", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/companies/batch/upsert_upsert", + command: "companies-batch-upsert", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/companies/batch/upsert", + }, + effect: "write", + summary: "Create or update a batch of companies by unique property values", + description: + "Create or update companies identified by a unique property value as specified by the `idProperty` query parameter. `idProperty` query param refers to a property whose values are unique for the object.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInputUpsert", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicUpsertObject", + }, + }, + { + id: "post-/crm/objects/2026-03/companies/merge_merge", + command: "companies-merge", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/companies/merge", + }, + effect: "destructive", + summary: "Merge two companies", + description: + "Merge two company records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records).", + tags: ["Advanced"], + security: [], + permissions: [ + { + key: "organizations.delete", + }, + ], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "PublicMergeInput", + }, + response: { + confidence: "contract", + schema: "SimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/companies/search_doSearch", + command: "companies-search", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/companies/search", + }, + effect: "read", + summary: "Search for companies", + description: + "Search for companies by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).", + tags: ["Search"], + security: [], + pagination: { + style: "cursor", + cursor: { + in: "body", + name: "after", + }, + next: "paging.next.after", + items: "results", + limit: { + in: "body", + name: "limit", + }, + }, + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "PublicObjectSearchRequest", + }, + response: { + confidence: "contract", + schema: "CollectionResponseWithTotalSimplePublicObject", + }, + }, + { + id: "get-/crm/objects/2026-03/companies/{companyId}_getById", + command: "companies-get", + binding: { + kind: "http", + method: "GET", + path: "/crm/objects/2026-03/companies/{companyId}", + }, + effect: "read", + summary: "Retrieve a company", + description: + "Retrieve a company by its ID (`companyId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter.", + tags: ["Basic"], + security: [], + parameters: [ + { + name: "companyId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + { + name: "associations", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + }, + { + name: "idProperty", + in: "query", + required: false, + schema: { + type: "string", + }, + description: "The name of a property whose values are unique for this object type", + }, + { + name: "properties", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + { + name: "propertiesWithHistory", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + ], + response: { + confidence: "contract", + schema: "SimplePublicObjectWithAssociations", + }, + }, + { + id: "patch-/crm/objects/2026-03/companies/{companyId}_update", + command: "companies-update", + binding: { + kind: "http", + method: "PATCH", + path: "/crm/objects/2026-03/companies/{companyId}", + }, + effect: "write", + summary: "Update a company", + description: + "Update a company by ID (`companyId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + tags: ["Basic"], + security: [], + parameters: [ + { + name: "companyId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + { + name: "idProperty", + in: "query", + required: false, + schema: { + type: "string", + }, + description: "The name of a property whose values are unique for this object type", + }, + ], + request: { + required: true, + confidence: "contract", + schema: "SimplePublicObjectInput", + }, + response: { + confidence: "contract", + schema: "SimplePublicObject", + }, + }, + { + id: "delete-/crm/objects/2026-03/companies/{companyId}_archive", + command: "companies-delete", + binding: { + kind: "http", + method: "DELETE", + path: "/crm/objects/2026-03/companies/{companyId}", + }, + effect: "destructive", + summary: "Archive a company", + description: + "Delete a company by ID. Deleted companies can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).", + tags: ["Basic"], + security: [], + permissions: [ + { + key: "organizations.delete", + }, + ], + parameters: [ + { + name: "companyId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + ], + }, + { + id: "get-/crm/objects/2026-03/0-3_getPage", + command: "deals-list", + binding: { + kind: "http", + method: "GET", + path: "/crm/objects/2026-03/0-3", + }, + effect: "read", + summary: "List", + description: "Read a page of deals. Control what is returned via the `properties` query param.", + tags: ["Basic"], + security: [], + pagination: { + style: "cursor", + cursor: { + in: "query", + name: "after", + }, + next: "paging.next.after", + items: "results", + limit: { + in: "query", + name: "limit", + }, + }, + parameters: [ + { + name: "after", + in: "query", + required: false, + schema: { + type: "string", + }, + description: + "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", + }, + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + { + name: "associations", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + }, + { + name: "limit", + in: "query", + required: false, + schema: { + default: 10, + type: "integer", + format: "int32", + }, + description: "The maximum number of results to display per page.", + }, + { + name: "properties", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + { + name: "propertiesWithHistory", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.", + }, + ], + response: { + confidence: "contract", + schema: "CollectionResponseSimplePublicObjectWithAssociationsForwardPaging", + }, + }, + { + id: "post-/crm/objects/2026-03/0-3_create", + command: "deals-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/0-3", + }, + effect: "write", + summary: "Create", + description: + "Create a deal with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard deals is provided.", + tags: ["Basic"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "SimplePublicObjectInputForCreate", + }, + response: { + confidence: "contract", + schema: "SimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/0-3/batch/archive_archive", + command: "deals-batch-archive", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/0-3/batch/archive", + }, + effect: "destructive", + summary: "Archive a batch of deals by ID", + description: "Archive multiple deals using their IDs.", + tags: ["Batch"], + security: [], + permissions: [ + { + key: "deals.delete", + }, + ], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectId", + }, + }, + { + id: "post-/crm/objects/2026-03/0-3/batch/create_create", + command: "deals-batch-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/0-3/batch/create", + }, + effect: "write", + summary: "Create a batch of deals", + description: "Create multiple deals in a single request.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInputForCreate", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/0-3/batch/read_read", + command: "deals-batch-read", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/0-3/batch/read", + }, + effect: "write", + summary: "Read a batch of deals by internal ID, or unique property values", + description: + "Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ", + tags: ["Batch"], + security: [], + parameters: [ + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + ], + request: { + required: true, + confidence: "contract", + schema: "BatchReadInputSimplePublicObjectId", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/0-3/batch/update_update", + command: "deals-batch-update", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/0-3/batch/update", + }, + effect: "write", + summary: "Update a batch of deals by internal ID, or unique property values", + description: "Update multiple deals using their internal IDs or unique property values.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInput", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/0-3/batch/upsert_upsert", + command: "deals-batch-upsert", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/0-3/batch/upsert", + }, + effect: "write", + summary: "Create or update a batch of deals by unique property values", + description: + "Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInputUpsert", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicUpsertObject", + }, + }, + { + id: "post-/crm/objects/2026-03/0-3/merge_merge", + command: "deals-merge", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/0-3/merge", + }, + effect: "destructive", + summary: "Merge two deals with same type", + description: "Combine two deals of the same type into a single deal.", + tags: ["Basic"], + security: [], + permissions: [ + { + key: "deals.delete", + }, + ], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "PublicMergeInput", + }, + response: { + confidence: "contract", + schema: "SimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/0-3/search_doSearch", + command: "deals-search", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/0-3/search", + }, + effect: "read", + summary: "Search for deals using various filters and criteria to retrieve specific records.", + description: "Search for deals using specified criteria and filters.", + tags: ["Search"], + security: [], + pagination: { + style: "cursor", + cursor: { + in: "body", + name: "after", + }, + next: "paging.next.after", + items: "results", + limit: { + in: "body", + name: "limit", + }, + }, + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "PublicObjectSearchRequest", + }, + response: { + confidence: "contract", + schema: "CollectionResponseWithTotalSimplePublicObject", + }, + }, + { + id: "get-/crm/objects/2026-03/0-3/{dealId}_getById", + command: "deals-get", + binding: { + kind: "http", + method: "GET", + path: "/crm/objects/2026-03/0-3/{dealId}", + }, + effect: "read", + summary: "Read", + description: + "Read an Object identified by `{dealId}`. `{dealId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.", + tags: ["Basic"], + security: [], + parameters: [ + { + name: "dealId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + { + name: "associations", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + }, + { + name: "idProperty", + in: "query", + required: false, + schema: { + type: "string", + }, + description: "The name of a property whose values are unique for this object type", + }, + { + name: "properties", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + { + name: "propertiesWithHistory", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + ], + response: { + confidence: "contract", + schema: "SimplePublicObjectWithAssociations", + }, + }, + { + id: "patch-/crm/objects/2026-03/0-3/{dealId}_update", + command: "deals-update", + binding: { + kind: "http", + method: "PATCH", + path: "/crm/objects/2026-03/0-3/{dealId}", + }, + effect: "write", + summary: "Update", + description: + "Perform a partial update of an Object identified by `{dealId}`or optionally a unique property value as specified by the `idProperty` query param. `{dealId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + tags: ["Basic"], + security: [], + parameters: [ + { + name: "dealId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + { + name: "idProperty", + in: "query", + required: false, + schema: { + type: "string", + }, + description: "The name of a property whose values are unique for this object type", + }, + ], + request: { + required: true, + confidence: "contract", + schema: "SimplePublicObjectInput", + }, + response: { + confidence: "contract", + schema: "SimplePublicObject", + }, + }, + { + id: "delete-/crm/objects/2026-03/0-3/{dealId}_archive", + command: "deals-delete", + binding: { + kind: "http", + method: "DELETE", + path: "/crm/objects/2026-03/0-3/{dealId}", + }, + effect: "destructive", + summary: "Archive", + description: "Move an Object identified by `{dealId}` to the recycling bin.", + tags: ["Basic"], + security: [], + permissions: [ + { + key: "deals.delete", + }, + ], + parameters: [ + { + name: "dealId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + ], + }, + { + id: "get-/crm/objects/2026-03/tickets_getPage", + command: "tickets-list", + binding: { + kind: "http", + method: "GET", + path: "/crm/objects/2026-03/tickets", + }, + effect: "read", + summary: "List", + description: "Read a page of tickets. Control what is returned via the `properties` query param.", + tags: ["Basic"], + security: [], + pagination: { + style: "cursor", + cursor: { + in: "query", + name: "after", + }, + next: "paging.next.after", + items: "results", + limit: { + in: "query", + name: "limit", + }, + }, + parameters: [ + { + name: "after", + in: "query", + required: false, + schema: { + type: "string", + }, + description: + "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", + }, + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + { + name: "associations", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + }, + { + name: "limit", + in: "query", + required: false, + schema: { + default: 10, + type: "integer", + format: "int32", + }, + description: "The maximum number of results to display per page.", + }, + { + name: "properties", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + { + name: "propertiesWithHistory", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.", + }, + ], + response: { + confidence: "contract", + schema: "CollectionResponseSimplePublicObjectWithAssociationsForwardPaging", + }, + }, + { + id: "post-/crm/objects/2026-03/tickets_create", + command: "tickets-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/tickets", + }, + effect: "write", + summary: "Create", + description: + "Create a ticket with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tickets is provided.", + tags: ["Basic"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "SimplePublicObjectInputForCreate", + }, + response: { + confidence: "contract", + schema: "SimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/tickets/batch/archive_archive", + command: "tickets-batch-archive", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/tickets/batch/archive", + }, + effect: "destructive", + summary: "Archive a batch of tickets by ID", + description: + "Delete a batch of tickets by ID. Deleted tickets can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).", + tags: ["Batch"], + security: [], + permissions: [ + { + key: "tickets.delete", + }, + ], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectId", + }, + }, + { + id: "post-/crm/objects/2026-03/tickets/batch/create_create", + command: "tickets-batch-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/tickets/batch/create", + }, + effect: "write", + summary: "Create a batch of tickets", + description: + "Create a batch of tickets. The `inputs` array can contain a `properties` object to define property values for the ticket, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInputForCreate", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/tickets/batch/read_read", + command: "tickets-batch-read", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/tickets/batch/read", + }, + effect: "write", + summary: "Read a batch of tickets by internal ID, or unique property values", + description: "Retrieve a batch of tickets by ID (`ticketId`) or unique property value (`idProperty`). ", + tags: ["Batch"], + security: [], + parameters: [ + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + ], + request: { + required: true, + confidence: "contract", + schema: "BatchReadInputSimplePublicObjectId", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/tickets/batch/update_update", + command: "tickets-batch-update", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/tickets/batch/update", + }, + effect: "write", + summary: "Update a batch of tickets by internal ID, or unique property values", + description: + "Update a batch of tickets by ID (`ticketId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInput", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/tickets/batch/upsert_upsert", + command: "tickets-batch-upsert", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/tickets/batch/upsert", + }, + effect: "write", + summary: "Create or update a batch of tickets by unique property values", + description: + "Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInputUpsert", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicUpsertObject", + }, + }, + { + id: "post-/crm/objects/2026-03/tickets/merge_merge", + command: "tickets-merge", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/tickets/merge", + }, + effect: "destructive", + summary: "Merge two tickets", + description: "Merge two tickets, combining them into one ticket record.", + tags: ["Advanced"], + security: [], + permissions: [ + { + key: "tickets.delete", + }, + ], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "PublicMergeInput", + }, + response: { + confidence: "contract", + schema: "SimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/tickets/search_doSearch", + command: "tickets-search", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/tickets/search", + }, + effect: "read", + summary: "Search for tickets", + description: + "Search for tickets by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).", + tags: ["Search"], + security: [], + pagination: { + style: "cursor", + cursor: { + in: "body", + name: "after", + }, + next: "paging.next.after", + items: "results", + limit: { + in: "body", + name: "limit", + }, + }, + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "PublicObjectSearchRequest", + }, + response: { + confidence: "contract", + schema: "CollectionResponseWithTotalSimplePublicObject", + }, + }, + { + id: "get-/crm/objects/2026-03/tickets/{ticketId}_getById", + command: "tickets-get", + binding: { + kind: "http", + method: "GET", + path: "/crm/objects/2026-03/tickets/{ticketId}", + }, + effect: "read", + summary: "Read", + description: + "Read an Object identified by `{ticketId}`. `{ticketId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.", + tags: ["Basic"], + security: [], + parameters: [ + { + name: "ticketId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + { + name: "associations", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + }, + { + name: "idProperty", + in: "query", + required: false, + schema: { + type: "string", + }, + description: "The name of a property whose values are unique for this object type", + }, + { + name: "properties", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + { + name: "propertiesWithHistory", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + ], + response: { + confidence: "contract", + schema: "SimplePublicObjectWithAssociations", + }, + }, + { + id: "patch-/crm/objects/2026-03/tickets/{ticketId}_update", + command: "tickets-update", + binding: { + kind: "http", + method: "PATCH", + path: "/crm/objects/2026-03/tickets/{ticketId}", + }, + effect: "write", + summary: "Update", + description: + "Perform a partial update of an Object identified by `{ticketId}`or optionally a unique property value as specified by the `idProperty` query param. `{ticketId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + tags: ["Basic"], + security: [], + parameters: [ + { + name: "ticketId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + { + name: "idProperty", + in: "query", + required: false, + schema: { + type: "string", + }, + description: "The name of a property whose values are unique for this object type", + }, + ], + request: { + required: true, + confidence: "contract", + schema: "SimplePublicObjectInput", + }, + response: { + confidence: "contract", + schema: "SimplePublicObject", + }, + }, + { + id: "delete-/crm/objects/2026-03/tickets/{ticketId}_archive", + command: "tickets-delete", + binding: { + kind: "http", + method: "DELETE", + path: "/crm/objects/2026-03/tickets/{ticketId}", + }, + effect: "destructive", + summary: "Archive", + description: "Move an Object identified by `{ticketId}` to the recycling bin.", + tags: ["Basic"], + security: [], + permissions: [ + { + key: "tickets.delete", + }, + ], + parameters: [ + { + name: "ticketId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + ], + }, + { + id: "get-/crm/objects/2026-03/leads_getPage", + command: "leads-list", + binding: { + kind: "http", + method: "GET", + path: "/crm/objects/2026-03/leads", + }, + effect: "read", + summary: "List", + description: "Read a page of leads. Control what is returned via the `properties` query param.", + tags: ["Basic"], + security: [], + pagination: { + style: "cursor", + cursor: { + in: "query", + name: "after", + }, + next: "paging.next.after", + items: "results", + limit: { + in: "query", + name: "limit", + }, + }, + parameters: [ + { + name: "after", + in: "query", + required: false, + schema: { + type: "string", + }, + description: + "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", + }, + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + { + name: "associations", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + }, + { + name: "limit", + in: "query", + required: false, + schema: { + default: 10, + type: "integer", + format: "int32", + }, + description: "The maximum number of results to display per page.", + }, + { + name: "properties", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + { + name: "propertiesWithHistory", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.", + }, + ], + response: { + confidence: "contract", + schema: "CollectionResponseSimplePublicObjectWithAssociationsForwardPaging", + }, + }, + { + id: "post-/crm/objects/2026-03/leads_create", + command: "leads-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/leads", + }, + effect: "write", + summary: "Create", + description: + "Create a lead with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard leads is provided.", + tags: ["Basic"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "SimplePublicObjectInputForCreate", + }, + response: { + confidence: "contract", + schema: "SimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/leads/batch/archive_archive", + command: "leads-batch-archive", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/leads/batch/archive", + }, + effect: "destructive", + summary: "Archive a batch of leads by ID", + description: "Archive multiple leads by their IDs in a single request, moving them to the recycling bin.", + tags: ["Batch"], + security: [], + permissions: [ + { + key: "leads.delete", + }, + ], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectId", + }, + }, + { + id: "post-/crm/objects/2026-03/leads/batch/create_create", + command: "leads-batch-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/leads/batch/create", + }, + effect: "write", + summary: "Create a batch of leads", + description: + "Create multiple lead records in a single request by providing a batch of lead data. This endpoint allows for efficient creation of leads by processing them together, which can be useful for syncing data from other systems or importing large datasets.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInputForCreate", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/leads/batch/read_read", + command: "leads-batch-read", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/leads/batch/read", + }, + effect: "write", + summary: "Read a batch of leads by internal ID, or unique property values", + description: + "Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ", + tags: ["Batch"], + security: [], + parameters: [ + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + ], + request: { + required: true, + confidence: "contract", + schema: "BatchReadInputSimplePublicObjectId", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/leads/batch/update_update", + command: "leads-batch-update", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/leads/batch/update", + }, + effect: "write", + summary: "Update a batch of leads by internal ID, or unique property values", + description: + "Update multiple lead records using their internal IDs or unique property values. This endpoint allows batch processing of updates, where each lead's properties can be modified based on the provided input. Ensure that the properties being updated exist on the lead objects to avoid errors.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInput", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/leads/batch/upsert_upsert", + command: "leads-batch-upsert", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/leads/batch/upsert", + }, + effect: "write", + summary: "Create or update a batch of leads by unique property values", + description: + "Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInputUpsert", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicUpsertObject", + }, + }, + { + id: "post-/crm/objects/2026-03/leads/search_doSearch", + command: "leads-search", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/leads/search", + }, + effect: "read", + summary: "Search for leads using specified criteria.", + description: + "Perform a search for leads based on the provided filter groups, properties, and sorting options. The request allows for pagination and can return up to 200 results per page.", + tags: ["Search"], + security: [], + pagination: { + style: "cursor", + cursor: { + in: "body", + name: "after", + }, + next: "paging.next.after", + items: "results", + limit: { + in: "body", + name: "limit", + }, + }, + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "PublicObjectSearchRequest", + }, + response: { + confidence: "contract", + schema: "CollectionResponseWithTotalSimplePublicObject", + }, + }, + { + id: "get-/crm/objects/2026-03/leads/{leadsId}_getById", + command: "leads-get", + binding: { + kind: "http", + method: "GET", + path: "/crm/objects/2026-03/leads/{leadsId}", + }, + effect: "read", + summary: "Read", + description: + "Read an Object identified by `{leadsId}`. `{leadsId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.", + tags: ["Basic"], + security: [], + parameters: [ + { + name: "leadsId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + { + name: "associations", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + }, + { + name: "idProperty", + in: "query", + required: false, + schema: { + type: "string", + }, + description: "The name of a property whose values are unique for this object type", + }, + { + name: "properties", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + { + name: "propertiesWithHistory", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + ], + response: { + confidence: "contract", + schema: "SimplePublicObjectWithAssociations", + }, + }, + { + id: "patch-/crm/objects/2026-03/leads/{leadsId}_update", + command: "leads-update", + binding: { + kind: "http", + method: "PATCH", + path: "/crm/objects/2026-03/leads/{leadsId}", + }, + effect: "write", + summary: "Update", + description: + "Perform a partial update of an Object identified by `{leadsId}`or optionally a unique property value as specified by the `idProperty` query param. `{leadsId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + tags: ["Basic"], + security: [], + parameters: [ + { + name: "leadsId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + { + name: "idProperty", + in: "query", + required: false, + schema: { + type: "string", + }, + description: "The name of a property whose values are unique for this object type", + }, + ], + request: { + required: true, + confidence: "contract", + schema: "SimplePublicObjectInput", + }, + response: { + confidence: "contract", + schema: "SimplePublicObject", + }, + }, + { + id: "delete-/crm/objects/2026-03/leads/{leadsId}_archive", + command: "leads-delete", + binding: { + kind: "http", + method: "DELETE", + path: "/crm/objects/2026-03/leads/{leadsId}", + }, + effect: "destructive", + summary: "Archive", + description: "Move an Object identified by `{leadsId}` to the recycling bin.", + tags: ["Basic"], + security: [], + permissions: [ + { + key: "leads.delete", + }, + ], + parameters: [ + { + name: "leadsId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + ], + }, + { + id: "get-/crm/objects/2026-03/notes_getPage", + command: "notes-list", + binding: { + kind: "http", + method: "GET", + path: "/crm/objects/2026-03/notes", + }, + effect: "read", + summary: "List", + description: "Read a page of notes. Control what is returned via the `properties` query param.", + tags: ["Basic"], + security: [], + pagination: { + style: "cursor", + cursor: { + in: "query", + name: "after", + }, + next: "paging.next.after", + items: "results", + limit: { + in: "query", + name: "limit", + }, + }, + parameters: [ + { + name: "after", + in: "query", + required: false, + schema: { + type: "string", + }, + description: + "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", + }, + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + { + name: "associations", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + }, + { + name: "limit", + in: "query", + required: false, + schema: { + default: 10, + type: "integer", + format: "int32", + }, + description: "The maximum number of results to display per page.", + }, + { + name: "properties", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + { + name: "propertiesWithHistory", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.", + }, + ], + response: { + confidence: "contract", + schema: "CollectionResponseSimplePublicObjectWithAssociationsForwardPaging", + }, + }, + { + id: "post-/crm/objects/2026-03/notes_create", + command: "notes-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/notes", + }, + effect: "write", + summary: "Create", + description: + "Create a note with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard notes is provided.", + tags: ["Basic"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "SimplePublicObjectInputForCreate", + }, + response: { + confidence: "contract", + schema: "SimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/notes/batch/archive_archive", + command: "notes-batch-archive", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/notes/batch/archive", + }, + effect: "destructive", + summary: "Archive a batch of notes by ID", + description: + "Archive multiple notes by their IDs in a single request. This operation moves the specified notes to the recycling bin, making them inaccessible from regular queries.", + tags: ["Batch"], + security: [], + permissions: [ + { + key: "notes.delete", + }, + ], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectId", + }, + }, + { + id: "post-/crm/objects/2026-03/notes/batch/create_create", + command: "notes-batch-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/notes/batch/create", + }, + effect: "write", + summary: "Create a batch of notes", + description: + "Create multiple notes in a single request by providing the necessary properties for each note. This operation returns the created notes with their unique identifiers.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInputForCreate", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/notes/batch/read_read", + command: "notes-batch-read", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/notes/batch/read", + }, + effect: "write", + summary: "Read a batch of notes by internal ID, or unique property values", + description: + "Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ", + tags: ["Batch"], + security: [], + parameters: [ + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + ], + request: { + required: true, + confidence: "contract", + schema: "BatchReadInputSimplePublicObjectId", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/notes/batch/update_update", + command: "notes-batch-update", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/notes/batch/update", + }, + effect: "write", + summary: "Update a batch of notes by internal ID, or unique property values", + description: + "Update multiple notes using their internal IDs or unique property values. This operation allows you to modify the properties of several notes in a single request, streamlining the process of managing note data in bulk.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInput", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/notes/batch/upsert_upsert", + command: "notes-batch-upsert", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/notes/batch/upsert", + }, + effect: "write", + summary: "Create or update a batch of notes by unique property values", + description: + "Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInputUpsert", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicUpsertObject", + }, + }, + { + id: "post-/crm/objects/2026-03/notes/search_doSearch", + command: "notes-search", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/notes/search", + }, + effect: "read", + summary: "Search for notes based on specified criteria.", + description: + "Execute a search for notes using filters, sorting options, and other query parameters to refine the results. This endpoint allows for complex queries to locate specific notes within the CRM system.", + tags: ["Search"], + security: [], + pagination: { + style: "cursor", + cursor: { + in: "body", + name: "after", + }, + next: "paging.next.after", + items: "results", + limit: { + in: "body", + name: "limit", + }, + }, + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "PublicObjectSearchRequest", + }, + response: { + confidence: "contract", + schema: "CollectionResponseWithTotalSimplePublicObject", + }, + }, + { + id: "get-/crm/objects/2026-03/notes/{noteId}_getById", + command: "notes-get", + binding: { + kind: "http", + method: "GET", + path: "/crm/objects/2026-03/notes/{noteId}", + }, + effect: "read", + summary: "Read", + description: + "Read an Object identified by `{noteId}`. `{noteId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.", + tags: ["Basic"], + security: [], + parameters: [ + { + name: "noteId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + { + name: "associations", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + }, + { + name: "idProperty", + in: "query", + required: false, + schema: { + type: "string", + }, + description: "The name of a property whose values are unique for this object type", + }, + { + name: "properties", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + { + name: "propertiesWithHistory", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + ], + response: { + confidence: "contract", + schema: "SimplePublicObjectWithAssociations", + }, + }, + { + id: "patch-/crm/objects/2026-03/notes/{noteId}_update", + command: "notes-update", + binding: { + kind: "http", + method: "PATCH", + path: "/crm/objects/2026-03/notes/{noteId}", + }, + effect: "write", + summary: "Update", + description: + "Perform a partial update of an Object identified by `{noteId}`or optionally a unique property value as specified by the `idProperty` query param. `{noteId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + tags: ["Basic"], + security: [], + parameters: [ + { + name: "noteId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + { + name: "idProperty", + in: "query", + required: false, + schema: { + type: "string", + }, + description: "The name of a property whose values are unique for this object type", + }, + ], + request: { + required: true, + confidence: "contract", + schema: "SimplePublicObjectInput", + }, + response: { + confidence: "contract", + schema: "SimplePublicObject", + }, + }, + { + id: "delete-/crm/objects/2026-03/notes/{noteId}_archive", + command: "notes-delete", + binding: { + kind: "http", + method: "DELETE", + path: "/crm/objects/2026-03/notes/{noteId}", + }, + effect: "destructive", + summary: "Archive", + description: "Move an Object identified by `{noteId}` to the recycling bin.", + tags: ["Basic"], + security: [], + permissions: [ + { + key: "notes.delete", + }, + ], + parameters: [ + { + name: "noteId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + ], + }, + { + id: "get-/crm/objects/2026-03/calls_getPage", + command: "calls-list", + binding: { + kind: "http", + method: "GET", + path: "/crm/objects/2026-03/calls", + }, + effect: "read", + summary: "List", + description: "Read a page of calls. Control what is returned via the `properties` query param.", + tags: ["Basic"], + security: [], + pagination: { + style: "cursor", + cursor: { + in: "query", + name: "after", + }, + next: "paging.next.after", + items: "results", + limit: { + in: "query", + name: "limit", + }, + }, + parameters: [ + { + name: "after", + in: "query", + required: false, + schema: { + type: "string", + }, + description: + "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", + }, + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + { + name: "associations", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + }, + { + name: "limit", + in: "query", + required: false, + schema: { + default: 10, + type: "integer", + format: "int32", + }, + description: "The maximum number of results to display per page.", + }, + { + name: "properties", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + { + name: "propertiesWithHistory", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.", + }, + ], + response: { + confidence: "contract", + schema: "CollectionResponseSimplePublicObjectWithAssociationsForwardPaging", + }, + }, + { + id: "post-/crm/objects/2026-03/calls_create", + command: "calls-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/calls", + }, + effect: "write", + summary: "Create", + description: + "Create a call with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard calls is provided.", + tags: ["Basic"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "SimplePublicObjectInputForCreate", + }, + response: { + confidence: "contract", + schema: "SimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/calls/batch/archive_archive", + command: "calls-batch-archive", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/calls/batch/archive", + }, + effect: "destructive", + summary: "Archive a batch of calls by ID", + description: + "Archive a batch of calls by ID. Deleted calls can be restored within 90 days of being deleted, but call recordings recording will be permanently deleted. Learn more about [restoring activity records](https://knowledge.hubspot.com/records/restore-deleted-activity-in-a-record).", + tags: ["Batch"], + security: [], + permissions: [ + { + key: "calls.delete", + }, + ], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectId", + }, + }, + { + id: "post-/crm/objects/2026-03/calls/batch/create_create", + command: "calls-batch-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/calls/batch/create", + }, + effect: "write", + summary: "Create a batch of calls", + description: + "Create a batch of calls. The `inputs` array can contain a `properties` object to define property values for each record, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInputForCreate", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/calls/batch/read_read", + command: "calls-batch-read", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/calls/batch/read", + }, + effect: "write", + summary: "Read a batch of calls by internal ID, or unique property values", + description: "Retrieve a batch of calls by ID.", + tags: ["Batch"], + security: [], + parameters: [ + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + ], + request: { + required: true, + confidence: "contract", + schema: "BatchReadInputSimplePublicObjectId", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/calls/batch/update_update", + command: "calls-batch-update", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/calls/batch/update", + }, + effect: "write", + summary: "Update a batch of calls by internal ID, or unique property values", + description: "Update a batch of calls by ID.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInput", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/calls/batch/upsert_upsert", + command: "calls-batch-upsert", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/calls/batch/upsert", + }, + effect: "write", + summary: "Create or update a batch of calls by unique property values", + description: + "Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInputUpsert", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicUpsertObject", + }, + }, + { + id: "post-/crm/objects/2026-03/calls/search_doSearch", + command: "calls-search", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/calls/search", + }, + effect: "read", + summary: "Search for calls", + description: + "Search for calls by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).", + tags: ["Search"], + security: [], + pagination: { + style: "cursor", + cursor: { + in: "body", + name: "after", + }, + next: "paging.next.after", + items: "results", + limit: { + in: "body", + name: "limit", + }, + }, + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "PublicObjectSearchRequest", + }, + response: { + confidence: "contract", + schema: "CollectionResponseWithTotalSimplePublicObject", + }, + }, + { + id: "get-/crm/objects/2026-03/calls/{callId}_getById", + command: "calls-get", + binding: { + kind: "http", + method: "GET", + path: "/crm/objects/2026-03/calls/{callId}", + }, + effect: "read", + summary: "Read", + description: + "Read an Object identified by `{callId}`. `{callId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.", + tags: ["Basic"], + security: [], + parameters: [ + { + name: "callId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + { + name: "associations", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + }, + { + name: "idProperty", + in: "query", + required: false, + schema: { + type: "string", + }, + description: "The name of a property whose values are unique for this object type", + }, + { + name: "properties", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + { + name: "propertiesWithHistory", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + ], + response: { + confidence: "contract", + schema: "SimplePublicObjectWithAssociations", + }, + }, + { + id: "patch-/crm/objects/2026-03/calls/{callId}_update", + command: "calls-update", + binding: { + kind: "http", + method: "PATCH", + path: "/crm/objects/2026-03/calls/{callId}", + }, + effect: "write", + summary: "Update", + description: + "Perform a partial update of an Object identified by `{callId}`or optionally a unique property value as specified by the `idProperty` query param. `{callId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + tags: ["Basic"], + security: [], + parameters: [ + { + name: "callId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + { + name: "idProperty", + in: "query", + required: false, + schema: { + type: "string", + }, + description: "The name of a property whose values are unique for this object type", + }, + ], + request: { + required: true, + confidence: "contract", + schema: "SimplePublicObjectInput", + }, + response: { + confidence: "contract", + schema: "SimplePublicObject", + }, + }, + { + id: "delete-/crm/objects/2026-03/calls/{callId}_archive", + command: "calls-delete", + binding: { + kind: "http", + method: "DELETE", + path: "/crm/objects/2026-03/calls/{callId}", + }, + effect: "destructive", + summary: "Archive", + description: "Move an Object identified by `{callId}` to the recycling bin.", + tags: ["Basic"], + security: [], + permissions: [ + { + key: "calls.delete", + }, + ], + parameters: [ + { + name: "callId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + ], + }, + { + id: "get-/crm/objects/2026-03/emails_getPage", + command: "emails-list", + binding: { + kind: "http", + method: "GET", + path: "/crm/objects/2026-03/emails", + }, + effect: "read", + summary: "List", + description: "Read a page of emails. Control what is returned via the `properties` query param.", + tags: ["Basic"], + security: [], + pagination: { + style: "cursor", + cursor: { + in: "query", + name: "after", + }, + next: "paging.next.after", + items: "results", + limit: { + in: "query", + name: "limit", + }, + }, + parameters: [ + { + name: "after", + in: "query", + required: false, + schema: { + type: "string", + }, + description: + "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", + }, + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + { + name: "associations", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + }, + { + name: "limit", + in: "query", + required: false, + schema: { + default: 10, + type: "integer", + format: "int32", + }, + description: "The maximum number of results to display per page.", + }, + { + name: "properties", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + { + name: "propertiesWithHistory", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.", + }, + ], + response: { + confidence: "contract", + schema: "CollectionResponseSimplePublicObjectWithAssociationsForwardPaging", + }, + }, + { + id: "post-/crm/objects/2026-03/emails_create", + command: "emails-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/emails", + }, + effect: "write", + summary: "Create", + description: + "Create a email with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard emails is provided.", + tags: ["Basic"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "SimplePublicObjectInputForCreate", + }, + response: { + confidence: "contract", + schema: "SimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/emails/batch/archive_archive", + command: "emails-batch-archive", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/emails/batch/archive", + }, + effect: "destructive", + summary: "Archive a batch of emails by ID", + description: "Archive a batch of emails identified by their IDs.", + tags: ["Batch"], + security: [], + permissions: [ + { + key: "emails.delete", + }, + ], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectId", + }, + }, + { + id: "post-/crm/objects/2026-03/emails/batch/create_create", + command: "emails-batch-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/emails/batch/create", + }, + effect: "write", + summary: "Create a batch of emails", + description: "Create a batch of emails with specified properties and return the created objects.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInputForCreate", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/emails/batch/read_read", + command: "emails-batch-read", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/emails/batch/read", + }, + effect: "write", + summary: "Read a batch of emails by internal ID, or unique property values", + description: + "Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ", + tags: ["Batch"], + security: [], + parameters: [ + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + ], + request: { + required: true, + confidence: "contract", + schema: "BatchReadInputSimplePublicObjectId", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/emails/batch/update_update", + command: "emails-batch-update", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/emails/batch/update", + }, + effect: "write", + summary: "Update a batch of emails by internal ID, or unique property values", + description: "Update a batch of emails using their internal IDs or unique property values.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInput", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/emails/batch/upsert_upsert", + command: "emails-batch-upsert", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/emails/batch/upsert", + }, + effect: "write", + summary: "Create or update a batch of emails by unique property values", + description: + "Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInputUpsert", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicUpsertObject", + }, + }, + { + id: "post-/crm/objects/2026-03/emails/search_doSearch", + command: "emails-search", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/emails/search", + }, + effect: "read", + summary: "Search for emails using specified criteria and filters.", + description: "Perform a search for emails based on the provided query parameters and return matching results.", + tags: ["Search"], + security: [], + pagination: { + style: "cursor", + cursor: { + in: "body", + name: "after", + }, + next: "paging.next.after", + items: "results", + limit: { + in: "body", + name: "limit", + }, + }, + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "PublicObjectSearchRequest", + }, + response: { + confidence: "contract", + schema: "CollectionResponseWithTotalSimplePublicObject", + }, + }, + { + id: "get-/crm/objects/2026-03/emails/{emailId}_getById", + command: "emails-get", + binding: { + kind: "http", + method: "GET", + path: "/crm/objects/2026-03/emails/{emailId}", + }, + effect: "read", + summary: "Read", + description: + "Read an Object identified by `{emailId}`. `{emailId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.", + tags: ["Basic"], + security: [], + parameters: [ + { + name: "emailId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + { + name: "associations", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + }, + { + name: "idProperty", + in: "query", + required: false, + schema: { + type: "string", + }, + description: "The name of a property whose values are unique for this object type", + }, + { + name: "properties", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + { + name: "propertiesWithHistory", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + ], + response: { + confidence: "contract", + schema: "SimplePublicObjectWithAssociations", + }, + }, + { + id: "patch-/crm/objects/2026-03/emails/{emailId}_update", + command: "emails-update", + binding: { + kind: "http", + method: "PATCH", + path: "/crm/objects/2026-03/emails/{emailId}", + }, + effect: "write", + summary: "Update", + description: + "Perform a partial update of an Object identified by `{emailId}`or optionally a unique property value as specified by the `idProperty` query param. `{emailId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + tags: ["Basic"], + security: [], + parameters: [ + { + name: "emailId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + { + name: "idProperty", + in: "query", + required: false, + schema: { + type: "string", + }, + description: "The name of a property whose values are unique for this object type", + }, + ], + request: { + required: true, + confidence: "contract", + schema: "SimplePublicObjectInput", + }, + response: { + confidence: "contract", + schema: "SimplePublicObject", + }, + }, + { + id: "delete-/crm/objects/2026-03/emails/{emailId}_archive", + command: "emails-delete", + binding: { + kind: "http", + method: "DELETE", + path: "/crm/objects/2026-03/emails/{emailId}", + }, + effect: "destructive", + summary: "Archive", + description: "Move an Object identified by `{emailId}` to the recycling bin.", + tags: ["Basic"], + security: [], + permissions: [ + { + key: "emails.delete", + }, + ], + parameters: [ + { + name: "emailId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + ], + }, + { + id: "get-/crm/objects/2026-03/meetings_getPage", + command: "meetings-list", + binding: { + kind: "http", + method: "GET", + path: "/crm/objects/2026-03/meetings", + }, + effect: "read", + summary: "List", + description: "Read a page of meetings. Control what is returned via the `properties` query param.", + tags: ["Basic"], + security: [], + pagination: { + style: "cursor", + cursor: { + in: "query", + name: "after", + }, + next: "paging.next.after", + items: "results", + limit: { + in: "query", + name: "limit", + }, + }, + parameters: [ + { + name: "after", + in: "query", + required: false, + schema: { + type: "string", + }, + description: + "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", + }, + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + { + name: "associations", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + }, + { + name: "limit", + in: "query", + required: false, + schema: { + default: 10, + type: "integer", + format: "int32", + }, + description: "The maximum number of results to display per page.", + }, + { + name: "properties", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + { + name: "propertiesWithHistory", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.", + }, + ], + response: { + confidence: "contract", + schema: "CollectionResponseSimplePublicObjectWithAssociationsForwardPaging", + }, + }, + { + id: "post-/crm/objects/2026-03/meetings_create", + command: "meetings-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/meetings", + }, + effect: "write", + summary: "Create", + description: + "Create a meeting with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard meetings is provided.", + tags: ["Basic"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "SimplePublicObjectInputForCreate", + }, + response: { + confidence: "contract", + schema: "SimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/meetings/batch/archive_archive", + command: "meetings-batch-archive", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/meetings/batch/archive", + }, + effect: "destructive", + summary: "Archive a batch of meetings by ID", + description: "Delete a batch of meetings by ID.", + tags: ["Batch"], + security: [], + permissions: [ + { + key: "meetings.delete", + }, + ], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectId", + }, + }, + { + id: "post-/crm/objects/2026-03/meetings/batch/create_create", + command: "meetings-batch-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/meetings/batch/create", + }, + effect: "write", + summary: "Create a batch of meetings", + description: + "Create a batch of meetings. The `inputs` array can contain a `properties` object to define property values for the record, along with an `associations` array to define relationships with other object records.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInputForCreate", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/meetings/batch/read_read", + command: "meetings-batch-read", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/meetings/batch/read", + }, + effect: "write", + summary: "Read a batch of meetings by internal ID, or unique property values", + description: + "Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ", + tags: ["Batch"], + security: [], + parameters: [ + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + ], + request: { + required: true, + confidence: "contract", + schema: "BatchReadInputSimplePublicObjectId", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/meetings/batch/update_update", + command: "meetings-batch-update", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/meetings/batch/update", + }, + effect: "write", + summary: "Update a batch of meetings by internal ID, or unique property values", + description: + "Update a batch of meetings by ID (`objectId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInput", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/meetings/batch/upsert_upsert", + command: "meetings-batch-upsert", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/meetings/batch/upsert", + }, + effect: "write", + summary: "Create or update a batch of meetings by unique property values", + description: + "Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInputUpsert", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicUpsertObject", + }, + }, + { + id: "post-/crm/objects/2026-03/meetings/search_doSearch", + command: "meetings-search", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/meetings/search", + }, + effect: "read", + summary: "Search for meetings", + description: "Search for meetings by filtering on properties, searching through associations, and sorting results.", + tags: ["Search"], + security: [], + pagination: { + style: "cursor", + cursor: { + in: "body", + name: "after", + }, + next: "paging.next.after", + items: "results", + limit: { + in: "body", + name: "limit", + }, + }, + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "PublicObjectSearchRequest", + }, + response: { + confidence: "contract", + schema: "CollectionResponseWithTotalSimplePublicObject", + }, + }, + { + id: "get-/crm/objects/2026-03/meetings/{meetingId}_getById", + command: "meetings-get", + binding: { + kind: "http", + method: "GET", + path: "/crm/objects/2026-03/meetings/{meetingId}", + }, + effect: "read", + summary: "Read", + description: + "Read an Object identified by `{meetingId}`. `{meetingId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.", + tags: ["Basic"], + security: [], + parameters: [ + { + name: "meetingId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + { + name: "associations", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + }, + { + name: "idProperty", + in: "query", + required: false, + schema: { + type: "string", + }, + description: "The name of a property whose values are unique for this object type", + }, + { + name: "properties", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + { + name: "propertiesWithHistory", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + ], + response: { + confidence: "contract", + schema: "SimplePublicObjectWithAssociations", + }, + }, + { + id: "patch-/crm/objects/2026-03/meetings/{meetingId}_update", + command: "meetings-update", + binding: { + kind: "http", + method: "PATCH", + path: "/crm/objects/2026-03/meetings/{meetingId}", + }, + effect: "write", + summary: "Update", + description: + "Perform a partial update of an Object identified by `{meetingId}`or optionally a unique property value as specified by the `idProperty` query param. `{meetingId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + tags: ["Basic"], + security: [], + parameters: [ + { + name: "meetingId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + { + name: "idProperty", + in: "query", + required: false, + schema: { + type: "string", + }, + description: "The name of a property whose values are unique for this object type", + }, + ], + request: { + required: true, + confidence: "contract", + schema: "SimplePublicObjectInput", + }, + response: { + confidence: "contract", + schema: "SimplePublicObject", + }, + }, + { + id: "delete-/crm/objects/2026-03/meetings/{meetingId}_archive", + command: "meetings-delete", + binding: { + kind: "http", + method: "DELETE", + path: "/crm/objects/2026-03/meetings/{meetingId}", + }, + effect: "destructive", + summary: "Archive", + description: "Move an Object identified by `{meetingId}` to the recycling bin.", + tags: ["Basic"], + security: [], + permissions: [ + { + key: "meetings.delete", + }, + ], + parameters: [ + { + name: "meetingId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + ], + }, + { + id: "get-/crm/objects/2026-03/tasks_getPage", + command: "tasks-list", + binding: { + kind: "http", + method: "GET", + path: "/crm/objects/2026-03/tasks", + }, + effect: "read", + summary: "List", + description: "Read a page of tasks. Control what is returned via the `properties` query param.", + tags: ["Basic"], + security: [], + pagination: { + style: "cursor", + cursor: { + in: "query", + name: "after", + }, + next: "paging.next.after", + items: "results", + limit: { + in: "query", + name: "limit", + }, + }, + parameters: [ + { + name: "after", + in: "query", + required: false, + schema: { + type: "string", + }, + description: + "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", + }, + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + { + name: "associations", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + }, + { + name: "limit", + in: "query", + required: false, + schema: { + default: 10, + type: "integer", + format: "int32", + }, + description: "The maximum number of results to display per page.", + }, + { + name: "properties", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + { + name: "propertiesWithHistory", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.", + }, + ], + response: { + confidence: "contract", + schema: "CollectionResponseSimplePublicObjectWithAssociationsForwardPaging", + }, + }, + { + id: "post-/crm/objects/2026-03/tasks_create", + command: "tasks-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/tasks", + }, + effect: "write", + summary: "Create", + description: + "Create a task with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tasks is provided.", + tags: ["Basic"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "SimplePublicObjectInputForCreate", + }, + response: { + confidence: "contract", + schema: "SimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/tasks/batch/archive_archive", + command: "tasks-batch-archive", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/tasks/batch/archive", + }, + effect: "destructive", + summary: "Archive a batch of tasks by ID", + description: + "Archive a batch of tasks by their IDs, moving them to the recycling bin. This operation requires a list of task IDs to be provided in the request body.", + tags: ["Batch"], + security: [], + permissions: [ + { + key: "tasks.delete", + }, + ], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectId", + }, + }, + { + id: "post-/crm/objects/2026-03/tasks/batch/create_create", + command: "tasks-batch-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/tasks/batch/create", + }, + effect: "write", + summary: "Create a batch of tasks", + description: + "Create multiple tasks in a single request by providing a batch of task properties and associations. This endpoint allows for efficient task creation by processing multiple tasks together.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInputForCreate", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/tasks/batch/read_read", + command: "tasks-batch-read", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/tasks/batch/read", + }, + effect: "write", + summary: "Read a batch of tasks by internal ID, or unique property values", + description: + "Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ", + tags: ["Batch"], + security: [], + parameters: [ + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + ], + request: { + required: true, + confidence: "contract", + schema: "BatchReadInputSimplePublicObjectId", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/tasks/batch/update_update", + command: "tasks-batch-update", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/tasks/batch/update", + }, + effect: "write", + summary: "Update a batch of tasks by internal ID, or unique property values", + description: + "Update multiple tasks in a single request using their internal IDs or unique property values. This operation allows you to modify the properties of each task in the batch, ensuring efficient management of task data.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInput", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicObject", + }, + }, + { + id: "post-/crm/objects/2026-03/tasks/batch/upsert_upsert", + command: "tasks-batch-upsert", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/tasks/batch/upsert", + }, + effect: "write", + summary: "Create or update a batch of tasks by unique property values", + description: + "Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.", + tags: ["Batch"], + security: [], + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "BatchInputSimplePublicObjectBatchInputUpsert", + }, + response: { + confidence: "contract", + schema: "BatchResponseSimplePublicUpsertObject", + }, + }, + { + id: "post-/crm/objects/2026-03/tasks/search_doSearch", + command: "tasks-search", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/tasks/search", + }, + effect: "read", + summary: "Search for tasks using specified criteria.", + description: + "Execute a search for tasks based on the provided criteria, including filters, properties, and sorting options. This allows for retrieving tasks that match specific conditions or property values.", + tags: ["Search"], + security: [], + pagination: { + style: "cursor", + cursor: { + in: "body", + name: "after", + }, + next: "paging.next.after", + items: "results", + limit: { + in: "body", + name: "limit", + }, + }, + parameters: [], + request: { + required: true, + confidence: "contract", + schema: "PublicObjectSearchRequest", + }, + response: { + confidence: "contract", + schema: "CollectionResponseWithTotalSimplePublicObject", + }, + }, + { + id: "get-/crm/objects/2026-03/tasks/{taskId}_getById", + command: "tasks-get", + binding: { + kind: "http", + method: "GET", + path: "/crm/objects/2026-03/tasks/{taskId}", + }, + effect: "read", + summary: "Read", + description: + "Read an Object identified by `{taskId}`. `{taskId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.", + tags: ["Basic"], + security: [], + parameters: [ + { + name: "taskId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + { + name: "associations", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + }, + { + name: "idProperty", + in: "query", + required: false, + schema: { + type: "string", + }, + description: "The name of a property whose values are unique for this object type", + }, + { + name: "properties", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + { + name: "propertiesWithHistory", + in: "query", + required: false, + schema: { + type: "array", + items: { + type: "string", + }, + }, + description: + "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.", + }, + ], + response: { + confidence: "contract", + schema: "SimplePublicObjectWithAssociations", + }, + }, + { + id: "patch-/crm/objects/2026-03/tasks/{taskId}_update", + command: "tasks-update", + binding: { + kind: "http", + method: "PATCH", + path: "/crm/objects/2026-03/tasks/{taskId}", + }, + effect: "write", + summary: "Update", + description: + "Perform a partial update of an Object identified by `{taskId}`or optionally a unique property value as specified by the `idProperty` query param. `{taskId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.", + tags: ["Basic"], + security: [], + parameters: [ + { + name: "taskId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + { + name: "idProperty", + in: "query", + required: false, + schema: { + type: "string", + }, + description: "The name of a property whose values are unique for this object type", + }, + ], + request: { + required: true, + confidence: "contract", + schema: "SimplePublicObjectInput", + }, + response: { + confidence: "contract", + schema: "SimplePublicObject", + }, + }, + { + id: "delete-/crm/objects/2026-03/tasks/{taskId}_archive", + command: "tasks-delete", + binding: { + kind: "http", + method: "DELETE", + path: "/crm/objects/2026-03/tasks/{taskId}", + }, + effect: "destructive", + summary: "Archive", + description: "Move an Object identified by `{taskId}` to the recycling bin.", + tags: ["Basic"], + security: [], + permissions: [ + { + key: "tasks.delete", + }, + ], + parameters: [ + { + name: "taskId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + ], + }, + { + id: "get-/crm/owners/2026-03_/crm/owners/v3", + command: "owners-list", + binding: { + kind: "http", + method: "GET", + path: "/crm/owners/2026-03", + }, + effect: "read", + summary: "List owners", + description: + "Retrieve a paginated list of owners from your HubSpot account. This endpoint allows filtering by email and supports pagination through the 'after' parameter. You can also specify the maximum number of results per page and choose to include archived owners in the response.", + tags: ["Basic"], + pagination: { + style: "cursor", + cursor: { + in: "query", + name: "after", + }, + next: "paging.next.after", + items: "results", + limit: { + in: "query", + name: "limit", + }, + }, + parameters: [ + { + name: "after", + in: "query", + required: false, + schema: { + type: "string", + }, + description: + "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", + }, + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + { + name: "email", + in: "query", + required: false, + schema: { + type: "string", + }, + description: "Filter by email address (optional)", + }, + { + name: "limit", + in: "query", + required: false, + schema: { + default: 100, + type: "integer", + format: "int32", + }, + description: "The maximum number of results to display per page.", + }, + ], + response: { + confidence: "contract", + schema: "CollectionResponsePublicOwnerForwardPaging", + }, + }, + { + id: "get-/crm/owners/2026-03/{ownerId}_getById", + command: "owners-get", + binding: { + kind: "http", + method: "GET", + path: "/crm/owners/2026-03/{ownerId}", + }, + effect: "read", + summary: "Retrieve a specific owner by ID", + description: "Retrieve details of a specific owner using either their 'id' or 'userId'.", + tags: ["Basic"], + parameters: [ + { + name: "ownerId", + in: "path", + required: true, + schema: { + type: "integer", + format: "int32", + }, + description: "The unique identifier of the owner to retrieve.", + }, + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + { + name: "idProperty", + in: "query", + required: false, + schema: { + default: "id", + type: "string", + enum: ["id", "userId"], + }, + description: + "Specifies which property to use for identifying the owner. Valid values are 'id' or 'userId'. Defaults to 'id'.", + }, + ], + response: { + confidence: "contract", + schema: "PublicOwner", + }, + }, + { + id: "get-/crm/pipelines/2026-03/{objectType}_getAll", + command: "pipelines-list", + binding: { + kind: "http", + method: "GET", + path: "/crm/pipelines/2026-03/{objectType}", + }, + effect: "read", + summary: "Retrieve all pipelines", + description: "Return all pipelines for the object type specified by `{objectType}`.", + tags: ["Basic"], + parameters: [ + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + ], + response: { + confidence: "contract", + schema: "CollectionResponsePipelineNoPaging", + }, + }, + { + id: "post-/crm/pipelines/2026-03/{objectType}_create", + command: "pipelines-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/pipelines/2026-03/{objectType}", + }, + effect: "write", + summary: "Create a pipeline", + description: + "Create a new pipeline with the provided property values. The entire pipeline object, including its unique ID, will be returned in the response.", + tags: ["Basic"], + parameters: [ + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + ], + request: { + required: true, + confidence: "contract", + schema: "PipelineInput", + }, + response: { + confidence: "contract", + schema: "Pipeline", + }, + }, + { + id: "get-/crm/pipelines/2026-03/{objectType}/{pipelineId}_getById", + command: "pipelines-get", + binding: { + kind: "http", + method: "GET", + path: "/crm/pipelines/2026-03/{objectType}/{pipelineId}", + }, + effect: "read", + summary: "Return a pipeline by ID", + description: "Return a single pipeline object identified by its unique `{pipelineId}`.", + tags: ["Basic"], + parameters: [ + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "pipelineId", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + ], + response: { + confidence: "contract", + schema: "Pipeline", + }, + }, + { + id: "put-/crm/pipelines/2026-03/{objectType}/{pipelineId}_replace", + command: "pipelines-replace", + binding: { + kind: "http", + method: "PUT", + path: "/crm/pipelines/2026-03/{objectType}/{pipelineId}", + }, + effect: "write", + summary: "Replace a pipeline", + description: "Replace all properties of an existing pipeline with the provided values.", + tags: ["Basic"], + parameters: [ + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "pipelineId", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "validateDealStageUsagesBeforeDelete", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + }, + { + name: "validateReferencesBeforeDelete", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + }, + ], + request: { + required: true, + confidence: "contract", + schema: "PipelineReplaceInput", + }, + response: { + confidence: "contract", + schema: "Pipeline", + }, + }, + { + id: "patch-/crm/pipelines/2026-03/{objectType}/{pipelineId}_update", + command: "pipelines-update", + binding: { + kind: "http", + method: "PATCH", + path: "/crm/pipelines/2026-03/{objectType}/{pipelineId}", + }, + effect: "write", + summary: "Perform a partial update of the pipeline identified by pipelineId.", + description: + "Perform a partial update of the pipeline identified by `{pipelineId}`. The updated pipeline will be returned in the response.", + tags: ["Basic"], + parameters: [ + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "pipelineId", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "validateDealStageUsagesBeforeDelete", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + }, + { + name: "validateReferencesBeforeDelete", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + }, + ], + request: { + required: true, + confidence: "contract", + schema: "PipelinePatchInput", + }, + response: { + confidence: "contract", + schema: "Pipeline", + }, + }, + { + id: "delete-/crm/pipelines/2026-03/{objectType}/{pipelineId}_archive", + command: "pipelines-delete", + binding: { + kind: "http", + method: "DELETE", + path: "/crm/pipelines/2026-03/{objectType}/{pipelineId}", + }, + effect: "destructive", + summary: "Delete a pipeline", + description: "Delete a pipeline identified by its unique pipelineId", + tags: ["Basic"], + permissions: [ + { + key: "pipelines.delete", + }, + ], + parameters: [ + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "pipelineId", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "validateDealStageUsagesBeforeDelete", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + }, + { + name: "validateReferencesBeforeDelete", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + }, + ], + }, + { + id: "get-/crm/pipelines/2026-03/{objectType}/{pipelineId}/audit_getAudit", + command: "pipelines-audit-list", + binding: { + kind: "http", + method: "GET", + path: "/crm/pipelines/2026-03/{objectType}/{pipelineId}/audit", + }, + effect: "read", + summary: "Return an audit of all changes to the pipeline", + description: + "Return a reverse chronological list of all mutations that have occurred on the pipeline identified by `{pipelineId}`.", + tags: ["Basic"], + parameters: [ + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "pipelineId", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + ], + response: { + confidence: "contract", + schema: "CollectionResponsePublicAuditInfoNoPaging", + }, + }, + { + id: "get-/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages_getAll", + command: "pipelines-stages-list", + binding: { + kind: "http", + method: "GET", + path: "/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages", + }, + effect: "read", + summary: "Return all stages of a pipeline", + description: "Return all the stages associated with the pipeline identified by `{pipelineId}`.", + tags: ["Basic"], + parameters: [ + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "pipelineId", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + ], + response: { + confidence: "contract", + schema: "CollectionResponsePipelineStageNoPaging", + }, + }, + { + id: "post-/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages_create", + command: "pipelines-stages-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages", + }, + effect: "write", + summary: "Create a pipeline stage", + description: "Create a new stage within the specified pipeline.", + tags: ["Basic"], + parameters: [ + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "pipelineId", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + ], + request: { + required: true, + confidence: "contract", + schema: "PipelineStageInput", + }, + response: { + confidence: "contract", + schema: "PipelineStage", + }, + }, + { + id: "get-/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}_getById", + command: "pipelines-stages-get", + binding: { + kind: "http", + method: "GET", + path: "/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}", + }, + effect: "read", + summary: "Return a pipeline stage by ID", + description: "Retrieve a specific stage from a pipeline using its ID.", + tags: ["Basic"], + parameters: [ + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "pipelineId", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "stageId", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + ], + response: { + confidence: "contract", + schema: "PipelineStage", + }, + }, + { + id: "put-/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}_replace", + command: "pipelines-stages-replace", + binding: { + kind: "http", + method: "PUT", + path: "/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}", + }, + effect: "write", + summary: "Replace a pipeline stage", + description: + "Replace all the properties of an existing pipeline stage with the values provided. The updated stage will be returned in the response.", + tags: ["Basic"], + parameters: [ + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "pipelineId", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "stageId", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + ], + request: { + required: true, + confidence: "contract", + schema: "PipelineStageReplaceInput", + }, + response: { + confidence: "contract", + schema: "PipelineStage", + }, + }, + { + id: "patch-/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}_update", + command: "pipelines-stages-update", + binding: { + kind: "http", + method: "PATCH", + path: "/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}", + }, + effect: "write", + summary: "Update specific properties of an existing pipeline stage.", + description: "Perform a partial update on a specific stage of a pipeline.", + tags: ["Basic"], + parameters: [ + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "pipelineId", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "stageId", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + ], + request: { + required: true, + confidence: "contract", + schema: "PipelineStagePatchInput", + }, + response: { + confidence: "contract", + schema: "PipelineStage", + }, + }, + { + id: "delete-/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}_archive", + command: "pipelines-stages-delete", + binding: { + kind: "http", + method: "DELETE", + path: "/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}", + }, + effect: "destructive", + summary: "Delete a pipeline stage", + description: "Delete a specific stage from a pipeline.", + tags: ["Basic"], + permissions: [ + { + key: "pipelines.delete", + }, + ], + parameters: [ + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "pipelineId", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "stageId", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "validateReferencesBeforeDelete", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + }, + ], + }, + { + id: "get-/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}/audit_getAudit", + command: "pipelines-stages-audit-list", + binding: { + kind: "http", + method: "GET", + path: "/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}/audit", + }, + effect: "read", + summary: "Retrieve a reverse chronological list of all changes made to a specific pipeline stage.", + description: + "Return a reverse chronological list of all mutations that have occurred on the pipeline stage identified by `{stageId}`.", + tags: ["Basic"], + parameters: [ + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "pipelineId", + in: "path", + required: true, + schema: { + type: "string", + pattern: ".+", + }, + }, + { + name: "stageId", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + ], + response: { + confidence: "contract", + schema: "CollectionResponsePublicAuditInfoNoPaging", + }, + }, + { + id: "get-/crm/properties/2026-03/{objectType}_/crm/properties/2025-09/{objectType}", + command: "properties-list", + binding: { + kind: "http", + method: "GET", + path: "/crm/properties/2026-03/{objectType}", + }, + effect: "read", + summary: "Read all properties", + description: "Read all existing properties for the specified object type and HubSpot account.", + tags: ["Basic"], + parameters: [ + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + description: + "The type of CRM object for which properties are being retrieved, such as 'contacts', 'companies', etc.", + }, + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + { + name: "dataSensitivity", + in: "query", + required: false, + schema: { + default: "non_sensitive", + type: "string", + enum: ["highly_sensitive", "non_sensitive", "sensitive"], + }, + description: + "Filter properties based on data sensitivity level. Valid values are 'non_sensitive', 'sensitive', and 'highly_sensitive'. Defaults to 'non_sensitive'.", + }, + { + name: "locale", + in: "query", + required: false, + schema: { + type: "string", + }, + description: "Specify the locale to retrieve properties in a particular language or regional format.", + }, + { + name: "properties", + in: "query", + required: false, + schema: { + type: "string", + }, + description: "A comma-separated list of property names to include in the response.", + }, + ], + response: { + confidence: "contract", + schema: "CollectionResponsePropertyNoPaging", + }, + }, + { + id: "post-/crm/properties/2026-03/{objectType}_/crm/properties/2025-09/{objectType}", + command: "properties-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/properties/2026-03/{objectType}", + }, + effect: "write", + summary: "Create a property", + description: "Create and return a copy of a new property for the specified object type.", + tags: ["Basic"], + parameters: [ + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + description: + "The type of object for which the property is being created, such as contacts, companies, or deals.", + }, + ], + request: { + required: true, + confidence: "contract", + schema: "PropertyCreate", + }, + response: { + confidence: "contract", + schema: "Property", + }, + }, + { + id: "post-/crm/properties/2026-03/{objectType}/batch/archive_/crm/properties/2025-09/{objectType}/batch/archive", + command: "properties-batch-archive", + binding: { + kind: "http", + method: "POST", + path: "/crm/properties/2026-03/{objectType}/batch/archive", + }, + effect: "destructive", + summary: "Archive a batch of properties", + description: + "Archive a provided list of properties. This method will return a 204 No Content response on success regardless of the initial state of the property (e.g. active, already archived, non-existent).", + tags: ["Batch"], + permissions: [ + { + key: "fields.delete", + }, + ], + parameters: [ + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + description: + "The type of object whose properties are to be archived. This is a required parameter and identifies the specific object type within HubSpot.", + }, + ], + request: { + required: true, + confidence: "contract", + schema: "BatchInputPropertyName", + }, + }, + { + id: "post-/crm/properties/2026-03/{objectType}/batch/create_/crm/properties/2025-09/{objectType}/batch/create", + command: "properties-batch-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/properties/2026-03/{objectType}/batch/create", + }, + effect: "write", + summary: "Create a batch of properties", + description: "Create a batch of properties using the same rules as when creating an individual property.", + tags: ["Batch"], + parameters: [ + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + description: + "The type of CRM object for which the properties are being created, such as contacts, companies, or deals.", + }, + ], + request: { + required: true, + confidence: "contract", + schema: "BatchInputPropertyCreate", + }, + response: { + confidence: "contract", + schema: "BatchResponseProperty", + }, + }, + { + id: "post-/crm/properties/2026-03/{objectType}/batch/read_/crm/properties/2025-09/{objectType}/batch/read", + command: "properties-batch-read", + binding: { + kind: "http", + method: "POST", + path: "/crm/properties/2026-03/{objectType}/batch/read", + }, + effect: "write", + summary: "Read a batch of properties", + description: "Read a provided list of properties.", + tags: ["Batch"], + parameters: [ + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + description: + "The type of CRM object for which properties are being retrieved. This is a required path parameter.", + }, + { + name: "locale", + in: "query", + required: false, + schema: { + type: "string", + }, + description: + "A string specifying the locale to use for the response. This can be used to tailor the response to a specific language or region.", + }, + ], + request: { + required: true, + confidence: "contract", + schema: "BatchReadInputPropertyName", + }, + response: { + confidence: "contract", + schema: "BatchResponseProperty", + }, + }, + { + id: "get-/crm/properties/2026-03/{objectType}/groups_/crm/properties/2025-09/{objectType}/groups", + command: "properties-groups-list", + binding: { + kind: "http", + method: "GET", + path: "/crm/properties/2026-03/{objectType}/groups", + }, + effect: "read", + summary: "Read all property groups", + description: "Read all existing property groups for the specified object type and HubSpot account.", + tags: ["Basic"], + parameters: [ + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + description: "The type of CRM object for which to retrieve property groups, such as 'contacts' or 'deals'.", + }, + { + name: "locale", + in: "query", + required: false, + schema: { + type: "string", + }, + description: + "The language locale to use for property group labels. This can help in displaying labels in the preferred language.", + }, + ], + response: { + confidence: "contract", + schema: "CollectionResponsePropertyGroupNoPaging", + }, + }, + { + id: "post-/crm/properties/2026-03/{objectType}/groups_/crm/properties/2025-09/{objectType}/groups", + command: "properties-groups-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/properties/2026-03/{objectType}/groups", + }, + effect: "write", + summary: "Create a property group", + description: "Create and return a copy of a new property group.", + tags: ["Basic"], + parameters: [ + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + description: + "The type of object for which the property group is being created, such as contacts, companies, or deals.", + }, + ], + request: { + required: true, + confidence: "contract", + schema: "PropertyGroupCreate", + }, + response: { + confidence: "contract", + schema: "PropertyGroup", + }, + }, + { + id: "get-/crm/properties/2026-03/{objectType}/groups/{groupName}_/crm/properties/2025-09/{objectType}/groups/{groupName}", + command: "properties-groups-get", + binding: { + kind: "http", + method: "GET", + path: "/crm/properties/2026-03/{objectType}/groups/{groupName}", + }, + effect: "read", + summary: "Read a property group", + description: "Read a property group identified by {groupName}.", + tags: ["Basic"], + parameters: [ + { + name: "groupName", + in: "path", + required: true, + schema: { + type: "string", + }, + description: "The name of the property group to retrieve details for.", + }, + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + description: + "The type of CRM object for which the property group is being retrieved, such as contacts or deals.", + }, + { + name: "locale", + in: "query", + required: false, + schema: { + type: "string", + }, + description: + "The language locale to use for the response. This can affect the language of the labels and descriptions returned.", + }, + ], + response: { + confidence: "contract", + schema: "PropertyGroup", + }, + }, + { + id: "patch-/crm/properties/2026-03/{objectType}/groups/{groupName}_/crm/properties/2025-09/{objectType}/groups/{groupName}", + command: "properties-groups-update", + binding: { + kind: "http", + method: "PATCH", + path: "/crm/properties/2026-03/{objectType}/groups/{groupName}", + }, + effect: "write", + summary: "Update a property group", + description: + "Perform a partial update of a property group identified by {groupName}. Provided fields will be overwritten.", + tags: ["Basic"], + parameters: [ + { + name: "groupName", + in: "path", + required: true, + schema: { + type: "string", + }, + description: "The name of the property group to update.", + }, + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + description: + "The type of object for which the property group is being updated, such as contacts, companies, or deals.", + }, + ], + request: { + required: true, + confidence: "contract", + schema: "PropertyGroupUpdate", + }, + response: { + confidence: "contract", + schema: "PropertyGroup", + }, + }, + { + id: "delete-/crm/properties/2026-03/{objectType}/groups/{groupName}_/crm/properties/2025-09/{objectType}/groups/{groupName}", + command: "properties-groups-delete", + binding: { + kind: "http", + method: "DELETE", + path: "/crm/properties/2026-03/{objectType}/groups/{groupName}", + }, + effect: "destructive", + summary: "Archive a property group", + description: "Move a property group identified by {groupName} to the recycling bin.", + tags: ["Basic"], + permissions: [ + { + key: "fields.delete", + }, + ], + parameters: [ + { + name: "groupName", + in: "path", + required: true, + schema: { + type: "string", + }, + description: "The unique name of the property group to be deleted.", + }, + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + description: + "The type of object for which the property group is defined, such as contacts, companies, or deals.", + }, + ], + }, + { + id: "get-/crm/properties/2026-03/{objectType}/{propertyName}_/crm/properties/2025-09/{objectType}/{propertyName}", + command: "properties-get", + binding: { + kind: "http", + method: "GET", + path: "/crm/properties/2026-03/{objectType}/{propertyName}", + }, + effect: "read", + summary: "Read a property", + description: "Read a property identified by {propertyName}.", + tags: ["Basic"], + parameters: [ + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + description: "The type of object the property belongs to, such as 'contacts' or 'deals'.", + }, + { + name: "propertyName", + in: "path", + required: true, + schema: { + type: "string", + }, + description: "The name of the property to retrieve.", + }, + { + name: "archived", + in: "query", + required: false, + schema: { + default: false, + type: "boolean", + }, + description: "Whether to return only results that have been archived.", + }, + { + name: "dataSensitivity", + in: "query", + required: false, + schema: { + default: "non_sensitive", + type: "string", + enum: ["highly_sensitive", "non_sensitive", "sensitive"], + }, + description: + "The level of data sensitivity to filter properties by. Valid values are 'non_sensitive', 'sensitive', and 'highly_sensitive'. Defaults to 'non_sensitive'.", + }, + { + name: "locale", + in: "query", + required: false, + schema: { + type: "string", + }, + description: "The locale to use for property labels and descriptions.", + }, + { + name: "properties", + in: "query", + required: false, + schema: { + type: "string", + }, + description: "A comma-separated list of property names to include in the response.", + }, + ], + response: { + confidence: "contract", + schema: "Property", + }, + }, + { + id: "patch-/crm/properties/2026-03/{objectType}/{propertyName}_/crm/properties/2025-09/{objectType}/{propertyName}", + command: "properties-update", + binding: { + kind: "http", + method: "PATCH", + path: "/crm/properties/2026-03/{objectType}/{propertyName}", + }, + effect: "write", + summary: "Update a property", + description: + "Perform a partial update of a property identified by { propertyName }. Provided fields will be overwritten.", + tags: ["Basic"], + parameters: [ + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + description: + "The type of object for which the property is being updated, such as contacts, companies, or deals.", + }, + { + name: "propertyName", + in: "path", + required: true, + schema: { + type: "string", + }, + description: "The unique name of the property to update.", + }, + ], + request: { + required: true, + confidence: "contract", + schema: "PropertyUpdate", + }, + response: { + confidence: "contract", + schema: "Property", + }, + }, + { + id: "delete-/crm/properties/2026-03/{objectType}/{propertyName}_/crm/properties/2025-09/{objectType}/{propertyName}", + command: "properties-delete", + binding: { + kind: "http", + method: "DELETE", + path: "/crm/properties/2026-03/{objectType}/{propertyName}", + }, + effect: "destructive", + summary: "Archive a property", + description: "Move a property identified by {propertyName} to the recycling bin.", + tags: ["Basic"], + permissions: [ + { + key: "fields.delete", + }, + ], + parameters: [ + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + description: "The type of CRM object that the property belongs to, such as contacts, companies, or deals.", + }, + { + name: "propertyName", + in: "path", + required: true, + schema: { + type: "string", + }, + description: "The unique name of the property to delete.", + }, + ], + }, + { + id: "post-/crm/associations/2026-03/usage/high-usage-report/{userId}_/crm/associations/2025-09/usage/high-usage-report/{userId}", + command: "associations-usage-high-usage-report-update", + binding: { + kind: "http", + method: "POST", + path: "/crm/associations/2026-03/usage/high-usage-report/{userId}", + }, + effect: "write", + summary: "Report high usage", + description: "Requests a report of all objects in the portal which have a high usage of associations", + tags: ["Basic"], + parameters: [ + { + name: "userId", + in: "path", + required: true, + schema: { + type: "integer", + format: "int32", + }, + }, + ], + response: { + confidence: "contract", + schema: "ReportCreationResponse", + }, + }, + { + id: "post-/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/archive_/crm/associations/2025-09/{fromObjectType}/{toObjectType}/batch/archive", + command: "associations-batch-archive", + binding: { + kind: "http", + method: "POST", + path: "/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/archive", + }, + effect: "destructive", + summary: "Remove associations", + description: "Batch delete associations for objects", + tags: ["Batch"], + permissions: [ + { + key: "associations.delete", + }, + ], + parameters: [ + { + name: "fromObjectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "toObjectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + ], + request: { + required: true, + confidence: "contract", + schema: "BatchInputPublicAssociationMultiArchive", + }, + response: { + confidence: "contract", + schema: "BatchResponse", + }, + }, + { + id: "post-/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/associate/default_/crm/associations/2025-09/{fromObjectType}/{toObjectType}/batch/associate/default", + command: "associations-batch-associate-default", + binding: { + kind: "http", + method: "POST", + path: "/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/associate/default", + }, + effect: "write", + summary: " Create Default Associations", + description: "Create the default (most generic) association type between two object types", + tags: ["Batch"], + parameters: [ + { + name: "fromObjectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "toObjectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + ], + request: { + required: true, + confidence: "contract", + schema: "BatchInputPublicDefaultAssociationMultiPost", + }, + response: { + confidence: "contract", + schema: "AssociationsBatchResponsePublicDefaultAssociation", + }, + }, + { + id: "post-/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/create_/crm/associations/2025-09/{fromObjectType}/{toObjectType}/batch/create", + command: "associations-batch-create", + binding: { + kind: "http", + method: "POST", + path: "/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/create", + }, + effect: "write", + summary: "Associate records (labelled)", + description: "Batch create associations for objects", + tags: ["Batch"], + parameters: [ + { + name: "fromObjectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "toObjectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + ], + request: { + required: true, + confidence: "contract", + schema: "BatchInputPublicAssociationMultiPost", + }, + response: { + confidence: "contract", + schema: "BatchResponseLabelsBetweenObjectPair", + }, + }, + { + id: "post-/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/labels/archive_/crm/associations/2025-09/{fromObjectType}/{toObjectType}/batch/labels/archive", + command: "associations-batch-labels-archive", + binding: { + kind: "http", + method: "POST", + path: "/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/labels/archive", + }, + effect: "destructive", + summary: "Delete Specific Labels", + description: + "Batch delete specific association labels for objects. Deleting an unlabeled association will also delete all labeled associations between those two objects", + tags: ["Batch"], + permissions: [ + { + key: "associations.delete", + }, + ], + parameters: [ + { + name: "fromObjectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "toObjectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + ], + request: { + required: true, + confidence: "contract", + schema: "BatchInputPublicAssociationMultiPost", + }, + response: { + confidence: "contract", + schema: "BatchResponse", + }, + }, + { + id: "post-/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/read_/crm/associations/2025-09/{fromObjectType}/{toObjectType}/batch/read", + command: "associations-batch-read", + binding: { + kind: "http", + method: "POST", + path: "/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/read", + }, + effect: "write", + summary: "Retrieve associations", + description: + "Batch read associations for objects to specific object type. The 'after' field in a returned paging object can be added alongside the 'id' to retrieve the next page of associations from that objectId. The 'link' field is deprecated and should be ignored. Note: The 'paging' field will only be present if there are more pages and absent otherwise.", + tags: ["Batch"], + parameters: [ + { + name: "fromObjectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "toObjectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + ], + request: { + required: true, + confidence: "contract", + schema: "BatchInputPublicFetchAssociationsBatchRequest", + }, + response: { + confidence: "contract", + schema: "BatchResponsePublicAssociationMultiWithLabel", + }, + }, + { + id: "post-/crm/objects/2026-03/{objectType}/search_/crm/objects/2025-09/{objectType}/search", + command: "search", + binding: { + kind: "http", + method: "POST", + path: "/crm/objects/2026-03/{objectType}/search", + }, + effect: "read", + summary: "", + description: "", + tags: ["Search"], + pagination: { + style: "cursor", + cursor: { + in: "body", + name: "after", + }, + next: "paging.next.after", + items: "results", + limit: { + in: "body", + name: "limit", + }, + }, + parameters: [ + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + ], + request: { + required: true, + confidence: "contract", + schema: "PublicObjectSearchRequest", + }, + response: { + confidence: "contract", + schema: "CollectionResponseWithTotalSimplePublicObject", + }, + }, + { + id: "get-/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}_/crm/objects/2025-09/{objectType}/{objectId}/associations/{toObjectType}", + command: "associations-get", + binding: { + kind: "http", + method: "GET", + path: "/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}", + }, + effect: "read", + summary: "Retrieve all associations by object type", + description: "Retrieve all associations between a specific record and an object type. Limit 500 per call.", + tags: ["Basic"], + pagination: { + style: "cursor", + cursor: { + in: "query", + name: "after", + }, + next: "paging.next.after", + items: "results", + limit: { + in: "query", + name: "limit", + }, + }, + parameters: [ + { + name: "objectId", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "objectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "toObjectType", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "after", + in: "query", + required: false, + schema: { + type: "string", + }, + description: + "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", + }, + { + name: "limit", + in: "query", + required: false, + schema: { + default: 500, + type: "integer", + format: "int32", + }, + description: "The maximum number of results to display per page.", + }, + ], + response: { + confidence: "contract", + schema: "CollectionResponseMultiAssociatedObjectWithLabelForwardPaging", + }, + }, + { + id: "get-/account-info/2026-03/api-usage/daily/private-apps_/account-info/2025-09/api-usage/daily/private-apps", + command: "account-info-api-usage-daily-private-apps-list", + binding: { + kind: "http", + method: "GET", + path: "/account-info/2026-03/api-usage/daily/private-apps", + }, + effect: "read", + summary: "Retrieve private app daily API usage", + description: + "Retrieve the daily API usage for private apps in the account, along with information about usage limits.", + tags: ["Basic"], + parameters: [], + response: { + confidence: "contract", + schema: "CollectionResponseApiUsageNoPaging", + }, + }, + { + id: "get-/account-info/2026-03/details_/account-info/2025-09/details", + command: "account-info-details-list", + binding: { + kind: "http", + method: "GET", + path: "/account-info/2026-03/details", + }, + effect: "read", + summary: "Retrieve account details", + description: + "Retrieve account details such as the account type, time zone, currencies, and data hosting location. ", + tags: ["Basic"], + parameters: [], + response: { + confidence: "contract", + schema: "PortalInformationResponse", + }, + }, +] + +export const servers: readonly ApiServer[] = [ + { + url: "https://api.hubapi.com", + }, +] + +export const securitySchemes: Readonly> = { + token: { + type: "http", + scheme: "bearer", }, } diff --git a/src/generated/schemas.ts b/src/generated/schemas.ts index 3837d5d..bdba23d 100644 --- a/src/generated/schemas.ts +++ b/src/generated/schemas.ts @@ -2,28 +2,1010 @@ // Source: spec/hubspot/, checked against provenance.json // Run: pnpm generate +import { int64, integer } from "@wirecat/cli-base/codegen/runtime" import * as v from "valibot" import type * as T from "./types.js" -export const NewComment: v.GenericSchema = v.looseObject({ - text: v.pipe(v.string(), v.minLength(1)), +export const AssociatedId: v.GenericSchema = v.looseObject({ + id: v.string(), + type: v.string(), +}) + +export const AssociationSpec: v.GenericSchema = v.looseObject({ + associationCategory: v.picklist(["HUBSPOT_DEFINED", "INTEGRATOR_DEFINED", "USER_DEFINED", "WORK"]), + associationTypeId: integer(), +}) + +export const BatchInputSimplePublicObjectBatchInput: v.GenericSchema< + unknown, + T.BatchInputSimplePublicObjectBatchInput +> = v.looseObject({ + inputs: v.array(v.lazy(() => SimplePublicObjectBatchInput)), +}) + +export const BatchInputSimplePublicObjectBatchInputForCreate: v.GenericSchema< + unknown, + T.BatchInputSimplePublicObjectBatchInputForCreate +> = v.looseObject({ + inputs: v.array(v.lazy(() => SimplePublicObjectBatchInputForCreate)), +}) + +export const BatchInputSimplePublicObjectBatchInputUpsert: v.GenericSchema< + unknown, + T.BatchInputSimplePublicObjectBatchInputUpsert +> = v.looseObject({ + inputs: v.array(v.lazy(() => SimplePublicObjectBatchInputUpsert)), +}) + +export const BatchInputSimplePublicObjectId: v.GenericSchema = v.looseObject( + { + inputs: v.array(v.lazy(() => SimplePublicObjectId)), + }, +) + +export const BatchReadInputSimplePublicObjectId: v.GenericSchema = + v.looseObject({ + idProperty: v.optional(v.string()), + inputs: v.array(v.lazy(() => SimplePublicObjectId)), + properties: v.array(v.string()), + propertiesWithHistory: v.array(v.string()), + }) + +export const BatchResponsePublicDefaultAssociation: v.GenericSchema = + v.looseObject({ + completedAt: v.string(), + errors: v.optional(v.array(v.lazy(() => StandardError))), + links: v.optional(v.record(v.string(), v.string())), + numErrors: v.optional(integer()), + requestedAt: v.optional(v.string()), + results: v.array(v.lazy(() => PublicDefaultAssociation)), + startedAt: v.string(), + status: v.picklist(["CANCELED", "COMPLETE", "PENDING", "PROCESSING"]), + }) + +export const BatchResponseSimplePublicObject: v.GenericSchema = + v.looseObject({ + completedAt: v.string(), + links: v.optional(v.record(v.string(), v.string())), + requestedAt: v.optional(v.string()), + results: v.array(v.lazy(() => SimplePublicObject)), + startedAt: v.string(), + status: v.picklist(["CANCELED", "COMPLETE", "PENDING", "PROCESSING"]), + }) + +export const BatchResponseSimplePublicObjectWithErrors: v.GenericSchema< + unknown, + T.BatchResponseSimplePublicObjectWithErrors +> = v.looseObject({ + completedAt: v.string(), + errors: v.optional(v.array(v.lazy(() => StandardError))), + links: v.optional(v.record(v.string(), v.string())), + numErrors: v.optional(integer()), + requestedAt: v.optional(v.string()), + results: v.array(v.lazy(() => SimplePublicObject)), + startedAt: v.string(), + status: v.picklist(["CANCELED", "COMPLETE", "PENDING", "PROCESSING"]), +}) + +export const BatchResponseSimplePublicUpsertObject: v.GenericSchema = + v.looseObject({ + completedAt: v.string(), + links: v.optional(v.record(v.string(), v.string())), + requestedAt: v.optional(v.string()), + results: v.array(v.lazy(() => SimplePublicUpsertObject)), + startedAt: v.string(), + status: v.picklist(["CANCELED", "COMPLETE", "PENDING", "PROCESSING"]), + }) + +export const BatchResponseSimplePublicUpsertObjectWithErrors: v.GenericSchema< + unknown, + T.BatchResponseSimplePublicUpsertObjectWithErrors +> = v.looseObject({ + completedAt: v.string(), + errors: v.optional(v.array(v.lazy(() => StandardError))), + links: v.optional(v.record(v.string(), v.string())), + numErrors: v.optional(integer()), + requestedAt: v.optional(v.string()), + results: v.array(v.lazy(() => SimplePublicUpsertObject)), + startedAt: v.string(), + status: v.picklist(["CANCELED", "COMPLETE", "PENDING", "PROCESSING"]), +}) + +export const CollectionResponseAssociatedId: v.GenericSchema = v.looseObject( + { + paging: v.optional(v.lazy(() => Paging)), + results: v.array(v.lazy(() => AssociatedId)), + }, +) + +export const CollectionResponseSimplePublicObjectWithAssociationsForwardPaging: v.GenericSchema< + unknown, + T.CollectionResponseSimplePublicObjectWithAssociationsForwardPaging +> = v.looseObject({ + paging: v.optional(v.lazy(() => ForwardPaging)), + results: v.array(v.lazy(() => SimplePublicObjectWithAssociations)), +}) + +export const CollectionResponseWithTotalSimplePublicObject: v.GenericSchema< + unknown, + T.CollectionResponseWithTotalSimplePublicObject +> = v.looseObject({ + paging: v.optional(v.lazy(() => Paging)), + results: v.array(v.lazy(() => SimplePublicObject)), + total: integer(), +}) + +export const ApiError: v.GenericSchema = v.looseObject({ + category: v.string(), + context: v.optional(v.record(v.string(), v.array(v.string()))), + correlationId: v.string(), + errors: v.optional(v.array(v.lazy(() => ErrorDetail))), + links: v.optional(v.record(v.string(), v.string())), + message: v.string(), + subCategory: v.optional(v.string()), +}) + +export const ErrorDetail: v.GenericSchema = v.looseObject({ + code: v.optional(v.string()), + context: v.optional(v.record(v.string(), v.array(v.string()))), + in: v.optional(v.string()), + message: v.string(), + subCategory: v.optional(v.string()), +}) + +export const Filter: v.GenericSchema = v.looseObject({ + highValue: v.optional(v.string()), + operator: v.picklist([ + "BETWEEN", + "CONTAINS_TOKEN", + "EQ", + "GT", + "GTE", + "HAS_PROPERTY", + "IN", + "LT", + "LTE", + "NEQ", + "NOT_CONTAINS_TOKEN", + "NOT_HAS_PROPERTY", + "NOT_IN", + ]), + propertyName: v.string(), + value: v.optional(v.string()), + values: v.optional(v.array(v.string())), +}) + +export const FilterGroup: v.GenericSchema = v.looseObject({ + filters: v.array(v.lazy(() => Filter)), +}) + +export const ForwardPaging: v.GenericSchema = v.looseObject({ + next: v.optional(v.lazy(() => NextPage)), +}) + +export const LabelsBetweenObjectPair: v.GenericSchema = v.looseObject({ + fromObjectId: v.string(), + fromObjectTypeId: v.string(), + labels: v.array(v.string()), + toObjectId: v.string(), + toObjectTypeId: v.string(), +}) + +export const NextPage: v.GenericSchema = v.looseObject({ + after: v.string(), + link: v.optional(v.string()), +}) + +export const Paging: v.GenericSchema = v.looseObject({ + next: v.optional(v.lazy(() => NextPage)), + prev: v.optional(v.lazy(() => PreviousPage)), +}) + +export const PreviousPage: v.GenericSchema = v.looseObject({ + before: v.string(), + link: v.optional(v.string()), +}) + +export const PublicAssociationsForObject: v.GenericSchema = v.looseObject({ + to: v.lazy(() => PublicObjectId), + types: v.array(v.lazy(() => AssociationSpec)), +}) + +export const PublicDefaultAssociation: v.GenericSchema = v.looseObject({ + associationSpec: v.lazy(() => AssociationSpec), + from: v.lazy(() => PublicObjectId), + to: v.lazy(() => PublicObjectId), +}) + +export const PublicGdprDeleteInput: v.GenericSchema = v.looseObject({ + idProperty: v.optional(v.string()), + objectId: v.string(), +}) + +export const PublicMergeInput: v.GenericSchema = v.looseObject({ + objectIdToMerge: v.string(), + primaryObjectId: v.string(), +}) + +export const PublicObjectId: v.GenericSchema = v.looseObject({ + id: v.string(), +}) + +export const PublicObjectSearchRequest: v.GenericSchema = v.looseObject({ + after: v.string(), + filterGroups: v.array(v.lazy(() => FilterGroup)), + limit: integer(), + properties: v.array(v.string()), + query: v.optional(v.string()), + sorts: v.array(v.string()), +}) + +export const PublicObjectWarning: v.GenericSchema = v.looseObject({ + category: v.string(), + context: v.record(v.string(), v.string()), + message: v.string(), +}) + +export const SimplePublicObject: v.GenericSchema = v.looseObject({ + archived: v.boolean(), + archivedAt: v.optional(v.string()), + createdAt: v.string(), + id: v.string(), + objectWriteTraceId: v.optional(v.string()), + properties: v.record(v.string(), v.string()), + propertiesWithHistory: v.optional(v.record(v.string(), v.array(v.lazy(() => ValueWithTimestamp)))), + updatedAt: v.string(), + url: v.optional(v.string()), + warnings: v.optional(v.array(v.lazy(() => PublicObjectWarning))), +}) + +export const SimplePublicObjectBatchInput: v.GenericSchema = v.looseObject({ + id: v.string(), + idProperty: v.optional(v.string()), + objectWriteTraceId: v.optional(v.string()), + properties: v.record(v.string(), v.string()), +}) + +export const SimplePublicObjectBatchInputForCreate: v.GenericSchema = + v.looseObject({ + associations: v.array(v.lazy(() => PublicAssociationsForObject)), + objectWriteTraceId: v.optional(v.string()), + properties: v.record(v.string(), v.string()), + }) + +export const SimplePublicObjectBatchInputUpsert: v.GenericSchema = + v.looseObject({ + id: v.string(), + idProperty: v.optional(v.string()), + objectWriteTraceId: v.optional(v.string()), + properties: v.record(v.string(), v.string()), + }) + +export const SimplePublicObjectId: v.GenericSchema = v.looseObject({ + id: v.string(), +}) + +export const SimplePublicObjectInput: v.GenericSchema = v.looseObject({ + properties: v.record(v.string(), v.string()), +}) + +export const SimplePublicObjectInputForCreate: v.GenericSchema = + v.looseObject({ + associations: v.array(v.lazy(() => PublicAssociationsForObject)), + properties: v.record(v.string(), v.string()), + }) + +export const SimplePublicObjectWithAssociations: v.GenericSchema = + v.looseObject({ + archived: v.boolean(), + archivedAt: v.optional(v.string()), + associations: v.optional( + v.record( + v.string(), + v.lazy(() => CollectionResponseAssociatedId), + ), + ), + createdAt: v.string(), + id: v.string(), + objectWriteTraceId: v.optional(v.string()), + properties: v.record(v.string(), v.string()), + propertiesWithHistory: v.optional(v.record(v.string(), v.array(v.lazy(() => ValueWithTimestamp)))), + updatedAt: v.string(), + url: v.optional(v.string()), + warnings: v.optional(v.array(v.lazy(() => PublicObjectWarning))), + }) + +export const SimplePublicUpsertObject: v.GenericSchema = v.looseObject({ + archived: v.boolean(), + archivedAt: v.optional(v.string()), + createdAt: v.string(), + id: v.string(), + new: v.boolean(), + objectWriteTraceId: v.optional(v.string()), + properties: v.record(v.string(), v.string()), + propertiesWithHistory: v.optional(v.record(v.string(), v.array(v.lazy(() => ValueWithTimestamp)))), + updatedAt: v.string(), + url: v.optional(v.string()), + warnings: v.optional(v.array(v.lazy(() => PublicObjectWarning))), +}) + +export const StandardError: v.GenericSchema = v.looseObject({ + category: v.string(), + context: v.record(v.string(), v.array(v.string())), + errors: v.array(v.lazy(() => ErrorDetail)), + id: v.optional(v.string()), + links: v.record(v.string(), v.string()), + message: v.string(), + status: v.string(), + subCategory: v.optional(v.looseObject({})), +}) + +export const ValueWithTimestamp: v.GenericSchema = v.looseObject({ + sourceId: v.optional(v.string()), + sourceLabel: v.optional(v.string()), + sourceType: v.string(), + timestamp: v.string(), + updatedByUserId: v.optional(integer()), + value: v.string(), +}) + +export const CollectionResponsePublicOwnerForwardPaging: v.GenericSchema< + unknown, + T.CollectionResponsePublicOwnerForwardPaging +> = v.looseObject({ + paging: v.optional(v.lazy(() => ForwardPaging)), + results: v.array(v.lazy(() => PublicOwner)), +}) + +export const PublicOwner: v.GenericSchema = v.looseObject({ + archived: v.boolean(), + createdAt: v.string(), + email: v.optional(v.string()), + firstName: v.optional(v.string()), + id: v.string(), + lastName: v.optional(v.string()), + teams: v.optional(v.array(v.lazy(() => PublicTeam))), + type: v.picklist(["PERSON", "QUEUE"]), + updatedAt: v.string(), + userId: v.optional(integer()), + userIdIncludingInactive: v.optional(integer()), +}) + +export const PublicTeam: v.GenericSchema = v.looseObject({ + id: v.string(), + name: v.string(), + primary: v.boolean(), +}) + +export const CollectionResponsePipelineNoPaging: v.GenericSchema = + v.looseObject({ + results: v.array(v.lazy(() => Pipeline)), + }) + +export const CollectionResponsePipelineStageNoPaging: v.GenericSchema< + unknown, + T.CollectionResponsePipelineStageNoPaging +> = v.looseObject({ + results: v.array(v.lazy(() => PipelineStage)), +}) + +export const CollectionResponsePublicAuditInfoNoPaging: v.GenericSchema< + unknown, + T.CollectionResponsePublicAuditInfoNoPaging +> = v.looseObject({ + results: v.array(v.lazy(() => PublicAuditInfo)), }) -export const Comment: v.GenericSchema = v.looseObject({ +export const Pipeline: v.GenericSchema = v.looseObject({ + archived: v.boolean(), + archivedAt: v.optional(v.string()), + createdAt: v.string(), + displayOrder: integer(), id: v.string(), - text: v.string(), - author: v.string(), - created_at: v.string(), + label: v.string(), + stages: v.array(v.lazy(() => PipelineStage)), + updatedAt: v.string(), }) -export const CommentList: v.GenericSchema = v.looseObject({ - results: v.array(v.lazy(() => Comment)), - has_more: v.boolean(), - next_cursor: v.optional(v.nullable(v.string())), +export const PipelineInput: v.GenericSchema = v.looseObject({ + displayOrder: integer(), + label: v.string(), + pipelineId: v.optional(v.string()), + stages: v.array(v.lazy(() => PipelineStageInput)), }) +export const PipelinePatchInput: v.GenericSchema = v.looseObject({ + archived: v.optional(v.boolean()), + displayOrder: v.optional(integer()), + label: v.optional(v.string()), +}) + +export const PipelineReplaceInput: v.GenericSchema = v.looseObject({ + displayOrder: integer(), + label: v.string(), + stages: v.array(v.lazy(() => PipelineStageInput)), +}) + +export const PipelineStage: v.GenericSchema = v.looseObject({ + archived: v.boolean(), + archivedAt: v.optional(v.string()), + createdAt: v.string(), + displayOrder: integer(), + id: v.string(), + label: v.string(), + metadata: v.record(v.string(), v.string()), + updatedAt: v.string(), + writePermissions: v.picklist(["CRM_PERMISSIONS_ENFORCEMENT", "INTERNAL_ONLY", "READ_ONLY"]), +}) + +export const PipelineStageInput: v.GenericSchema = v.looseObject({ + displayOrder: integer(), + label: v.string(), + metadata: v.record(v.string(), v.string()), + stageId: v.optional(v.string()), +}) + +export const PipelineStagePatchInput: v.GenericSchema = v.looseObject({ + archived: v.optional(v.boolean()), + displayOrder: v.optional(integer()), + label: v.optional(v.string()), + metadata: v.record(v.string(), v.string()), +}) + +export const PipelineStageReplaceInput: v.GenericSchema = v.looseObject({ + displayOrder: integer(), + label: v.string(), + metadata: v.record(v.string(), v.string()), +}) + +export const PublicAuditInfo: v.GenericSchema = v.looseObject({ + action: v.string(), + fromUserId: v.optional(integer()), + identifier: v.string(), + message: v.optional(v.string()), + portalId: integer(), + rawObject: v.optional(v.looseObject({})), + timestamp: v.optional(v.string()), +}) + +export const BatchInputPropertyCreate: v.GenericSchema = v.looseObject({ + inputs: v.array(v.lazy(() => PropertyCreate)), +}) + +export const BatchInputPropertyName: v.GenericSchema = v.looseObject({ + inputs: v.array(v.lazy(() => PropertyName)), +}) + +export const BatchReadInputPropertyName: v.GenericSchema = v.looseObject({ + archived: v.boolean(), + dataSensitivity: v.picklist(["highly_sensitive", "non_sensitive", "sensitive"]), + inputs: v.array(v.lazy(() => PropertyName)), +}) + +export const BatchResponseProperty: v.GenericSchema = v.looseObject({ + completedAt: v.string(), + links: v.optional(v.record(v.string(), v.string())), + requestedAt: v.optional(v.string()), + results: v.array(v.lazy(() => Property)), + startedAt: v.string(), + status: v.picklist(["CANCELED", "COMPLETE", "PENDING", "PROCESSING"]), +}) + +export const BatchResponsePropertyWithErrors: v.GenericSchema = + v.looseObject({ + completedAt: v.string(), + errors: v.optional(v.array(v.lazy(() => StandardError))), + links: v.optional(v.record(v.string(), v.string())), + numErrors: v.optional(integer()), + requestedAt: v.optional(v.string()), + results: v.array(v.lazy(() => Property)), + startedAt: v.string(), + status: v.picklist(["CANCELED", "COMPLETE", "PENDING", "PROCESSING"]), + }) + +export const CollectionResponsePropertyGroupNoPaging: v.GenericSchema< + unknown, + T.CollectionResponsePropertyGroupNoPaging +> = v.looseObject({ + results: v.array(v.lazy(() => PropertyGroup)), +}) + +export const CollectionResponsePropertyNoPaging: v.GenericSchema = + v.looseObject({ + results: v.array(v.lazy(() => Property)), + }) + +export const Option: v.GenericSchema = v.looseObject({ + description: v.optional(v.string()), + displayOrder: v.optional(integer()), + hidden: v.boolean(), + label: v.string(), + value: v.string(), +}) + +export const OptionInput: v.GenericSchema = v.looseObject({ + description: v.optional(v.string()), + displayOrder: integer(), + hidden: v.boolean(), + label: v.string(), + value: v.string(), +}) + +export const Property: v.GenericSchema = v.looseObject({ + archived: v.optional(v.boolean()), + archivedAt: v.optional(v.string()), + calculated: v.optional(v.boolean()), + calculationFormula: v.optional(v.string()), + createdAt: v.optional(v.string()), + createdUserId: v.optional(v.string()), + currencyPropertyName: v.optional(v.string()), + dataSensitivity: v.optional(v.picklist(["highly_sensitive", "non_sensitive", "sensitive"])), + dateDisplayHint: v.optional(v.picklist(["absolute", "absolute_with_relative", "time_since", "time_until"])), + description: v.string(), + displayOrder: v.optional(integer()), + externalOptions: v.optional(v.boolean()), + fieldType: v.string(), + formField: v.optional(v.boolean()), + groupName: v.string(), + hasUniqueValue: v.optional(v.boolean()), + hidden: v.optional(v.boolean()), + hubspotDefined: v.optional(v.boolean()), + label: v.string(), + modificationMetadata: v.optional(v.lazy(() => PropertyModificationMetadata)), + name: v.string(), + numberDisplayHint: v.optional( + v.picklist(["currency", "duration", "formatted", "percentage", "probability", "unformatted"]), + ), + options: v.array(v.lazy(() => Option)), + referencedObjectType: v.optional(v.string()), + sensitiveDataCategories: v.optional(v.array(v.string())), + showCurrencySymbol: v.optional(v.boolean()), + textDisplayHint: v.optional( + v.picklist([ + "domain_name", + "email", + "ip_address", + "multi_line", + "phone_number", + "physical_address", + "postal_code", + "unformatted_single_line", + ]), + ), + type: v.string(), + updatedAt: v.optional(v.string()), + updatedUserId: v.optional(v.string()), +}) + +export const PropertyCreate: v.GenericSchema = v.looseObject({ + calculationFormula: v.optional(v.string()), + currencyPropertyName: v.optional(v.string()), + dataSensitivity: v.optional(v.picklist(["highly_sensitive", "non_sensitive", "sensitive"])), + description: v.optional(v.string()), + displayOrder: v.optional(integer()), + externalOptions: v.optional(v.boolean()), + fieldType: v.picklist([ + "booleancheckbox", + "calculation_equation", + "checkbox", + "date", + "file", + "html", + "number", + "phonenumber", + "radio", + "select", + "text", + "textarea", + ]), + formField: v.optional(v.boolean()), + groupName: v.string(), + hasUniqueValue: v.optional(v.boolean()), + hidden: v.optional(v.boolean()), + label: v.string(), + name: v.string(), + numberDisplayHint: v.optional( + v.picklist(["currency", "duration", "formatted", "percentage", "probability", "unformatted"]), + ), + options: v.optional(v.array(v.lazy(() => OptionInput))), + referencedObjectType: v.optional(v.string()), + showCurrencySymbol: v.optional(v.boolean()), + textDisplayHint: v.optional( + v.picklist([ + "domain_name", + "email", + "ip_address", + "multi_line", + "phone_number", + "physical_address", + "postal_code", + "unformatted_single_line", + ]), + ), + type: v.picklist(["bool", "date", "datetime", "enumeration", "number", "phone_number", "string"]), +}) + +export const PropertyGroup: v.GenericSchema = v.looseObject({ + archived: v.boolean(), + displayOrder: v.optional(integer()), + label: v.string(), + name: v.string(), +}) + +export const PropertyGroupCreate: v.GenericSchema = v.looseObject({ + displayOrder: v.optional(integer()), + label: v.string(), + name: v.string(), +}) + +export const PropertyGroupUpdate: v.GenericSchema = v.looseObject({ + displayOrder: v.optional(integer()), + label: v.optional(v.string()), +}) + +export const PropertyModificationMetadata: v.GenericSchema = v.looseObject({ + archivable: v.boolean(), + readOnlyDefinition: v.boolean(), + readOnlyOptions: v.optional(v.boolean()), + readOnlyValue: v.boolean(), +}) + +export const PropertyName: v.GenericSchema = v.looseObject({ + name: v.string(), +}) + +export const PropertyUpdate: v.GenericSchema = v.looseObject({ + calculationFormula: v.optional(v.string()), + currencyPropertyName: v.optional(v.string()), + description: v.optional(v.string()), + displayOrder: v.optional(integer()), + fieldType: v.optional( + v.picklist([ + "booleancheckbox", + "calculation_equation", + "checkbox", + "date", + "file", + "html", + "number", + "phonenumber", + "radio", + "select", + "text", + "textarea", + ]), + ), + formField: v.optional(v.boolean()), + groupName: v.optional(v.string()), + hidden: v.optional(v.boolean()), + label: v.optional(v.string()), + numberDisplayHint: v.optional( + v.picklist(["currency", "duration", "formatted", "percentage", "probability", "unformatted"]), + ), + options: v.optional(v.array(v.lazy(() => OptionInput))), + showCurrencySymbol: v.optional(v.boolean()), + textDisplayHint: v.optional( + v.picklist([ + "domain_name", + "email", + "ip_address", + "multi_line", + "phone_number", + "physical_address", + "postal_code", + "unformatted_single_line", + ]), + ), + type: v.optional(v.picklist(["bool", "date", "datetime", "enumeration", "number", "phone_number", "string"])), +}) + +export const AssociationSpecWithLabel: v.GenericSchema = v.looseObject({ + category: v.picklist(["HUBSPOT_DEFINED", "INTEGRATOR_DEFINED", "USER_DEFINED", "WORK"]), + fromObjectTypeId: v.optional(v.string()), + label: v.optional(v.string()), + toObjectTypeId: v.optional(v.string()), + typeId: integer(), +}) + +export const BatchInputPublicAssociationMultiArchive: v.GenericSchema< + unknown, + T.BatchInputPublicAssociationMultiArchive +> = v.looseObject({ + inputs: v.array(v.lazy(() => PublicAssociationMultiArchive)), +}) + +export const BatchInputPublicAssociationMultiPost: v.GenericSchema = + v.looseObject({ + inputs: v.array(v.lazy(() => PublicAssociationMultiPost)), + }) + +export const BatchInputPublicDefaultAssociationMultiPost: v.GenericSchema< + unknown, + T.BatchInputPublicDefaultAssociationMultiPost +> = v.looseObject({ + inputs: v.array(v.lazy(() => PublicDefaultAssociationMultiPost)), +}) + +export const BatchInputPublicFetchAssociationsBatchRequest: v.GenericSchema< + unknown, + T.BatchInputPublicFetchAssociationsBatchRequest +> = v.looseObject({ + inputs: v.array(v.lazy(() => PublicFetchAssociationsBatchRequest)), +}) + +export const BatchResponse: v.GenericSchema = v.looseObject({ + completedAt: v.string(), + errors: v.optional(v.array(v.lazy(() => StandardError))), + links: v.optional(v.record(v.string(), v.string())), + numErrors: v.optional(integer()), + requestedAt: v.optional(v.string()), + results: v.array(v.looseObject({})), + startedAt: v.string(), + status: v.picklist(["CANCELED", "COMPLETE", "PENDING", "PROCESSING"]), +}) + +export const BatchResponseLabelsBetweenObjectPair: v.GenericSchema = + v.looseObject({ + completedAt: v.string(), + links: v.optional(v.record(v.string(), v.string())), + requestedAt: v.optional(v.string()), + results: v.array(v.lazy(() => LabelsBetweenObjectPair)), + startedAt: v.string(), + status: v.picklist(["CANCELED", "COMPLETE", "PENDING", "PROCESSING"]), + }) + +export const BatchResponseLabelsBetweenObjectPairWithErrors: v.GenericSchema< + unknown, + T.BatchResponseLabelsBetweenObjectPairWithErrors +> = v.looseObject({ + completedAt: v.string(), + errors: v.optional(v.array(v.lazy(() => StandardError))), + links: v.optional(v.record(v.string(), v.string())), + numErrors: v.optional(integer()), + requestedAt: v.optional(v.string()), + results: v.array(v.lazy(() => LabelsBetweenObjectPair)), + startedAt: v.string(), + status: v.picklist(["CANCELED", "COMPLETE", "PENDING", "PROCESSING"]), +}) + +export const BatchResponsePublicAssociationMultiWithLabel: v.GenericSchema< + unknown, + T.BatchResponsePublicAssociationMultiWithLabel +> = v.looseObject({ + completedAt: v.string(), + links: v.optional(v.record(v.string(), v.string())), + requestedAt: v.optional(v.string()), + results: v.array(v.lazy(() => PublicAssociationMultiWithLabel)), + startedAt: v.string(), + status: v.picklist(["CANCELED", "COMPLETE", "PENDING", "PROCESSING"]), +}) + +export const BatchResponsePublicAssociationMultiWithLabelWithErrors: v.GenericSchema< + unknown, + T.BatchResponsePublicAssociationMultiWithLabelWithErrors +> = v.looseObject({ + completedAt: v.string(), + errors: v.optional(v.array(v.lazy(() => StandardError))), + links: v.optional(v.record(v.string(), v.string())), + numErrors: v.optional(integer()), + requestedAt: v.optional(v.string()), + results: v.array(v.lazy(() => PublicAssociationMultiWithLabel)), + startedAt: v.string(), + status: v.picklist(["CANCELED", "COMPLETE", "PENDING", "PROCESSING"]), +}) + +export const AssociationsBatchResponsePublicDefaultAssociation: v.GenericSchema< + unknown, + T.AssociationsBatchResponsePublicDefaultAssociation +> = v.looseObject({ + completedAt: v.string(), + errors: v.optional(v.array(v.lazy(() => StandardError))), + links: v.optional(v.record(v.string(), v.string())), + numErrors: v.optional(integer()), + requestedAt: v.optional(v.string()), + results: v.array(v.lazy(() => PublicDefaultAssociation1)), + startedAt: v.string(), + status: v.picklist(["CANCELED", "COMPLETE", "PENDING", "PROCESSING"]), +}) + +export const CollectionResponseMultiAssociatedObjectWithLabelForwardPaging: v.GenericSchema< + unknown, + T.CollectionResponseMultiAssociatedObjectWithLabelForwardPaging +> = v.looseObject({ + paging: v.optional(v.lazy(() => ForwardPaging)), + results: v.array(v.lazy(() => MultiAssociatedObjectWithLabel)), +}) + +export const DateTime: v.GenericSchema = v.looseObject({ + dateOnly: v.boolean(), + timeZoneShift: integer(), + value: int64(), +}) + +export const MultiAssociatedObjectWithLabel: v.GenericSchema = v.looseObject( + { + associationTypes: v.array(v.lazy(() => AssociationSpecWithLabel)), + toObjectId: v.string(), + }, +) + +export const Paging1: v.GenericSchema = v.looseObject({ + next: v.optional(v.lazy(() => NextPage)), + prev: v.optional(v.lazy(() => PreviousPage)), +}) + +export const PublicAssociationMultiArchive: v.GenericSchema = v.looseObject({ + from: v.lazy(() => PublicObjectId), + to: v.array(v.lazy(() => PublicObjectId)), +}) + +export const PublicAssociationMultiPost: v.GenericSchema = v.looseObject({ + from: v.lazy(() => PublicObjectId), + to: v.lazy(() => PublicObjectId), + types: v.array(v.lazy(() => AssociationSpec)), +}) + +export const PublicAssociationMultiWithLabel: v.GenericSchema = + v.looseObject({ + from: v.lazy(() => PublicObjectId), + paging: v.optional(v.lazy(() => Paging1)), + to: v.array(v.lazy(() => MultiAssociatedObjectWithLabel)), + }) + +export const PublicDefaultAssociationMultiPost: v.GenericSchema = + v.looseObject({ + from: v.lazy(() => PublicObjectId), + to: v.lazy(() => PublicObjectId), + }) + +export const PublicDefaultAssociation1: v.GenericSchema = v.looseObject({ + associationSpec: v.lazy(() => AssociationSpec), + from: v.lazy(() => PublicObjectId), + to: v.lazy(() => PublicObjectId), +}) + +export const PublicFetchAssociationsBatchRequest: v.GenericSchema = + v.looseObject({ + after: v.optional(v.string()), + id: v.string(), + }) + +export const ReportCreationResponse: v.GenericSchema = v.looseObject({ + enqueueTime: v.lazy(() => DateTime), + userEmail: v.string(), + userId: integer(), +}) + +export const ApiUsage: v.GenericSchema = v.looseObject({ + collectedAt: v.string(), + currentUsage: integer(), + fetchStatus: v.picklist(["CACHED", "FAILURE", "NOTFOUND", "SUCCESS", "TIMEOUT"]), + name: v.string(), + resetsAt: v.optional(v.string()), + usageLimit: integer(), +}) + +export const CollectionResponseApiUsageNoPaging: v.GenericSchema = + v.looseObject({ + results: v.array(v.lazy(() => ApiUsage)), + }) + +export const PortalInformationResponse: v.GenericSchema = v.looseObject({ + accountType: v.picklist(["APP_DEVELOPER", "DEVELOPER_TEST", "SANDBOX", "STANDARD"]), + additionalCurrencies: v.array(v.string()), + companyCurrency: v.string(), + dataHostingLocation: v.string(), + portalId: integer(), + timeZone: v.string(), + uiDomain: v.string(), + utcOffset: v.string(), + utcOffsetMilliseconds: int64(), +}) + +export const PutCrmObjects202603ObjectTypeObjectIdAssociationsToObjectTypeToObjectIdCrmObjects202603ObjectTypeObjectIdAssociationsToObjectTypeToObjectIdRequest: v.GenericSchema< + unknown, + T.PutCrmObjects202603ObjectTypeObjectIdAssociationsToObjectTypeToObjectIdCrmObjects202603ObjectTypeObjectIdAssociationsToObjectTypeToObjectIdRequest +> = v.array(v.lazy(() => AssociationSpec)) + export const schemas = { - NewComment, - Comment, - CommentList, + AssociatedId, + AssociationSpec, + BatchInputSimplePublicObjectBatchInput, + BatchInputSimplePublicObjectBatchInputForCreate, + BatchInputSimplePublicObjectBatchInputUpsert, + BatchInputSimplePublicObjectId, + BatchReadInputSimplePublicObjectId, + BatchResponsePublicDefaultAssociation, + BatchResponseSimplePublicObject, + BatchResponseSimplePublicObjectWithErrors, + BatchResponseSimplePublicUpsertObject, + BatchResponseSimplePublicUpsertObjectWithErrors, + CollectionResponseAssociatedId, + CollectionResponseSimplePublicObjectWithAssociationsForwardPaging, + CollectionResponseWithTotalSimplePublicObject, + ApiError, + ErrorDetail, + Filter, + FilterGroup, + ForwardPaging, + LabelsBetweenObjectPair, + NextPage, + Paging, + PreviousPage, + PublicAssociationsForObject, + PublicDefaultAssociation, + PublicGdprDeleteInput, + PublicMergeInput, + PublicObjectId, + PublicObjectSearchRequest, + PublicObjectWarning, + SimplePublicObject, + SimplePublicObjectBatchInput, + SimplePublicObjectBatchInputForCreate, + SimplePublicObjectBatchInputUpsert, + SimplePublicObjectId, + SimplePublicObjectInput, + SimplePublicObjectInputForCreate, + SimplePublicObjectWithAssociations, + SimplePublicUpsertObject, + StandardError, + ValueWithTimestamp, + CollectionResponsePublicOwnerForwardPaging, + PublicOwner, + PublicTeam, + CollectionResponsePipelineNoPaging, + CollectionResponsePipelineStageNoPaging, + CollectionResponsePublicAuditInfoNoPaging, + Pipeline, + PipelineInput, + PipelinePatchInput, + PipelineReplaceInput, + PipelineStage, + PipelineStageInput, + PipelineStagePatchInput, + PipelineStageReplaceInput, + PublicAuditInfo, + BatchInputPropertyCreate, + BatchInputPropertyName, + BatchReadInputPropertyName, + BatchResponseProperty, + BatchResponsePropertyWithErrors, + CollectionResponsePropertyGroupNoPaging, + CollectionResponsePropertyNoPaging, + Option, + OptionInput, + Property, + PropertyCreate, + PropertyGroup, + PropertyGroupCreate, + PropertyGroupUpdate, + PropertyModificationMetadata, + PropertyName, + PropertyUpdate, + AssociationSpecWithLabel, + BatchInputPublicAssociationMultiArchive, + BatchInputPublicAssociationMultiPost, + BatchInputPublicDefaultAssociationMultiPost, + BatchInputPublicFetchAssociationsBatchRequest, + BatchResponse, + BatchResponseLabelsBetweenObjectPair, + BatchResponseLabelsBetweenObjectPairWithErrors, + BatchResponsePublicAssociationMultiWithLabel, + BatchResponsePublicAssociationMultiWithLabelWithErrors, + AssociationsBatchResponsePublicDefaultAssociation, + CollectionResponseMultiAssociatedObjectWithLabelForwardPaging, + DateTime, + MultiAssociatedObjectWithLabel, + Paging1, + PublicAssociationMultiArchive, + PublicAssociationMultiPost, + PublicAssociationMultiWithLabel, + PublicDefaultAssociationMultiPost, + PublicDefaultAssociation1, + PublicFetchAssociationsBatchRequest, + ReportCreationResponse, + ApiUsage, + CollectionResponseApiUsageNoPaging, + PortalInformationResponse, + PutCrmObjects202603ObjectTypeObjectIdAssociationsToObjectTypeToObjectIdCrmObjects202603ObjectTypeObjectIdAssociationsToObjectTypeToObjectIdRequest, } as const diff --git a/src/generated/types.ts b/src/generated/types.ts index 2c04769..a32ac04 100644 --- a/src/generated/types.ts +++ b/src/generated/types.ts @@ -2,19 +2,1204 @@ // Source: spec/hubspot/, checked against provenance.json // Run: pnpm generate -export type NewComment = { - text: string +/** Contains the id and type of an association */ +export type AssociatedId = { + /** The unique identifier for the associated object. */ + id: string + /** The type of associations. */ + type: string +} + +/** Defines the type, direction, and details of the relationship between two CRM objects. */ +export type AssociationSpec = { + /** The category of the association, indicating its origin or purpose. Valid values include "HUBSPOT_DEFINED", "USER_DEFINED", "INTEGRATOR_DEFINED", and "WORK". */ + associationCategory: "HUBSPOT_DEFINED" | "INTEGRATOR_DEFINED" | "USER_DEFINED" | "WORK" + /** An integer representing the unique identifier for the type of association. */ + associationTypeId: number +} + +/** Represents a batch input component used to handle multiple simple public objects in a single API request. This component is typically used when performing batch operations to create, update, or delete multiple records simultaneously. */ +export type BatchInputSimplePublicObjectBatchInput = { + /** An array of simple public objects to be processed in the batch operation. Each object in the array contains the data necessary for the specific operation being performed. */ + inputs: Array +} + +/** Represents a batch input for creating multiple simple public objects in a single request. This component is used to streamline the process of adding new objects to a HubSpot account by allowing multiple entries to be created at once. */ +export type BatchInputSimplePublicObjectBatchInputForCreate = { + /** An array of simple public objects to be created. Each object in the array contains the necessary data for creating a new entry in the system. */ + inputs: Array +} + +/** Represents a batch input operation for upserting simple public objects in HubSpot. This component is used to process multiple upsert operations in a single request, improving efficiency and performance. */ +export type BatchInputSimplePublicObjectBatchInputUpsert = { + /** An array of simple public objects to be upserted. Each object in the array contains the necessary data for creating or updating a record in HubSpot. */ + inputs: Array +} + +/** Represents a batch input payload containing a list of simple public object IDs. This component is used when performing batch operations on multiple objects within HubSpot. */ +export type BatchInputSimplePublicObjectId = { + /** An array of simple public object IDs to be processed in the batch operation. */ + inputs: Array +} + +/** Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property. */ +export type BatchReadInputSimplePublicObjectId = { + /** When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID. */ + idProperty?: string + /** An array of SimplePublicObjectId objects, each containing the ID of an object to be read. */ + inputs: Array + /** An array of the property names to be returned in the response. If a specified property is not present on the requested object(s), it will be ignored. */ + properties: Array + /** An array of the property names to be returned along with their history of previous values. If a specified property is not present on the requested object(s), it will be ignored. */ + propertiesWithHistory: Array +} + +/** The response returned after performing a batch operation on associations. */ +export type BatchResponsePublicDefaultAssociation = { + /** The timestamp when the batch process was completed, in ISO 8601 format. */ + completedAt: string + /** An array of StandardError objects detailing any errors that occurred during the batch operation. */ + errors?: Array + /** A map of link names to associated URIs, providing additional information or actions related to the batch operation. */ + links?: { [key: string]: string } + /** The total number of errors that occurred during the operation. */ + numErrors?: number + /** The timestamp when the batch process was initiated, in ISO 8601 format. */ + requestedAt?: string + /** An array of PublicDefaultAssociation objects representing the results of the batch operation. */ + results: Array + /** The timestamp when the batch process began execution, in ISO 8601 format. */ + startedAt: string + /** The status of the batch processing request. Can be: "PENDING", "PROCESSING", "CANCELED", or "COMPLETE". */ + status: "CANCELED" | "COMPLETE" | "PENDING" | "PROCESSING" +} + +/** A public object batch response object */ +export type BatchResponseSimplePublicObject = { + /** The timestamp when the batch processing was completed, in ISO 8601 format. */ + completedAt: string + /** A map of link names to associated URIs, providing additional information or actions related to the batch operation. */ + links?: { [key: string]: string } + /** The timestamp when the batch request was initially made, in ISO 8601 format. */ + requestedAt?: string + /** An array of SimplePublicObject items representing the results of the batch operation. */ + results: Array + /** The timestamp when the batch processing began, in ISO 8601 format. */ + startedAt: string + /** The status of the batch processing request. The expected value is "COMPLETE". */ + status: "CANCELED" | "COMPLETE" | "PENDING" | "PROCESSING" +} + +/** Represents the result of a batch operation on CRM objects, including the processing status, batch results, timestamps, and a list of any errors encountered during the operation. */ +export type BatchResponseSimplePublicObjectWithErrors = { + /** The timestamp when the batch process was completed, in ISO 8601 format. */ + completedAt: string + errors?: Array + /** An object containing relevant links related to the batch request. */ + links?: { [key: string]: string } + /** The number of errors encountered during the batch process. */ + numErrors?: number + /** The timestamp when the batch process was initiated, in ISO 8601 format. */ + requestedAt?: string + results: Array + /** The timestamp when the batch process began execution, in ISO 8601 format. */ + startedAt: string + /** The status of the batch processing request - "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE" */ + status: "CANCELED" | "COMPLETE" | "PENDING" | "PROCESSING" +} + +/** Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects. */ +export type BatchResponseSimplePublicUpsertObject = { + /** The timestamp when the batch process was completed, in ISO 8601 format. */ + completedAt: string + /** A map of link names to associated URIs, providing additional information or actions related to the batch operation. */ + links?: { [key: string]: string } + /** The timestamp when the batch process was initiated, in ISO 8601 format. */ + requestedAt?: string + /** An array of SimplePublicUpsertObject items representing the results of the batch upsert operation. */ + results: Array + /** The timestamp when the batch process began execution, in ISO 8601 format. */ + startedAt: string + /** The status of the batch processing request. Can be: "PENDING", "PROCESSING", "CANCELED", or "COMPLETE". */ + status: "CANCELED" | "COMPLETE" | "PENDING" | "PROCESSING" +} + +/** Represents the response from a batch upsert operation, including the status, timestamps, successfully processed objects, and any errors that occurred during processing. */ +export type BatchResponseSimplePublicUpsertObjectWithErrors = { + /** The timestamp when the batch process was completed, in ISO 8601 format. */ + completedAt: string + errors?: Array + /** An object containing relevant links related to the batch request. */ + links?: { [key: string]: string } + /** The number of errors encountered during the batch process. */ + numErrors?: number + /** The timestamp when the batch process was initiated, in ISO 8601 format. */ + requestedAt?: string + results: Array + /** The timestamp when the batch process began execution, in ISO 8601 format. */ + startedAt: string + /** The status of the batch processing request. Can be: "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE". */ + status: "CANCELED" | "COMPLETE" | "PENDING" | "PROCESSING" +} + +/** Represents a collection of associated IDs returned by an API request, including pagination details for navigating through the results. */ +export type CollectionResponseAssociatedId = { + paging?: Paging + /** A list of associated IDs retrieved from the API request. */ + results: Array +} + +/** Represents a paginated collection response that includes simple public objects with their associations. This component is used to handle the results and pagination details when retrieving a list of objects from the API. */ +export type CollectionResponseSimplePublicObjectWithAssociationsForwardPaging = { + paging?: ForwardPaging + /** An array of simple public objects that are included in the current page of the response. Each object may include its associated data. */ + results: Array +} + +/** Represents a list of simple objects returned from an API request, along with the total count of objects available. */ +export type CollectionResponseWithTotalSimplePublicObject = { + paging?: Paging + /** An array containing the simple public objects returned in the current page of the response. This property is required. */ + results: Array + /** The number of available results */ + total: number +} + +/** Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered. */ +export type ApiError = { + /** The error category */ + category: string + /** Context about the error condition */ + context?: { [key: string]: Array } + /** A unique identifier for the request. Include this value with any error reports or support tickets */ + correlationId: string + /** further information about the error */ + errors?: Array + /** A map of link names to associated URIs containing documentation about the error or recommended remediation steps */ + links?: { [key: string]: string } + /** A human readable message describing the error along with remediation steps where appropriate */ + message: string + /** A specific category that contains more specific detail about the error */ + subCategory?: string +} + +/** Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response. */ +export type ErrorDetail = { + /** The status code associated with the error detail */ + code?: string + /** Context about the error condition */ + context?: { [key: string]: Array } + /** The name of the field or parameter in which the error was found. */ + in?: string + /** A human readable message describing the error along with remediation steps where appropriate */ + message: string + /** A specific category that contains more specific detail about the error */ + subCategory?: string +} + +/** Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against. */ +export type Filter = { + /** The upper boundary value when using ranged-based filters. */ + highValue?: string + /** The comparison operator used in the filter, such as "EQ" or "GT". */ + operator: + | "BETWEEN" + | "CONTAINS_TOKEN" + | "EQ" + | "GT" + | "GTE" + | "HAS_PROPERTY" + | "IN" + | "LT" + | "LTE" + | "NEQ" + | "NOT_CONTAINS_TOKEN" + | "NOT_HAS_PROPERTY" + | "NOT_IN" + /** The name of the property to apply the filter to. */ + propertyName: string + /** The value to match against the property. */ + value?: string + /** The values to match against the property. */ + values?: Array +} + +/** Represents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints. */ +export type FilterGroup = { + /** A list of individual filter criteria that are applied together as a group. Each filter specifies a condition that records must meet to be included in the results. */ + filters: Array +} + +/** Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page. */ +export type ForwardPaging = { + next?: NextPage } -export type Comment = { +/** The relationship descriptors applicable between two object types. */ +export type LabelsBetweenObjectPair = { + /** Source unique ID of the object. */ + fromObjectId: string + /** Source object type. */ + fromObjectTypeId: string + /** An array of labels that describe the relationship between the two objects. This is a required property. */ + labels: Array + /** Target unique ID of the object. */ + toObjectId: string + /** Target object type. */ + toObjectTypeId: string +} + +/** Specifies the paging information needed to retrieve the next set of results in a paginated API response */ +export type NextPage = { + /** A paging cursor token for retrieving subsequent pages. */ + after: string + /** A URL that can be used to retrieve the next page results. */ + link?: string +} + +/** Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results. */ +export type Paging = { + next?: NextPage + prev?: PreviousPage +} + +/** specifies the paging information needed to retrieve the previous set of results in a paginated API response */ +export type PreviousPage = { + /** A paging cursor token for retrieving previous pages. */ + before: string + /** A URL that can be used to retrieve the previous pages' results. */ + link?: string +} + +/** Represents the associations for a specific object in HubSpot, detailing the types of associations and the related objects involved. */ +export type PublicAssociationsForObject = { + to: PublicObjectId + /** The types of associations that exist between the object and other entities, indicating the nature of their relationship. */ + types: Array +} + +/** The PublicDefaultAssociation component represents the default association configuration between two objects in HubSpot. It is used to define how objects are related to each other within the platform. */ +export type PublicDefaultAssociation = { + associationSpec: AssociationSpec + from: PublicObjectId + to: PublicObjectId +} + +/** An input that contains the information required to process a public GDPR data deletion request. */ +export type PublicGdprDeleteInput = { + /** The name of a property whose values are unique for this object. An alternative to identifying a contact by ID. */ + idProperty?: string + /** The ID of the contact to permanently delete. */ + objectId: string +} + +/** Input data for merging two records. */ +export type PublicMergeInput = { + /** The object ID of the record that the merge will not set as the current value after the merge. */ + objectIdToMerge: string + /** The object ID of the record that the merge will generally set as the current value after the merge. */ + primaryObjectId: string +} + +/** Contains the Id of a Public Object */ +export type PublicObjectId = { + /** The unique ID of the object. */ + id: string +} + +/** Describes a search request */ +export type PublicObjectSearchRequest = { + /** A paging cursor token for retrieving subsequent pages. */ + after: string + /** Up to 6 groups of filters defining additional query criteria. */ + filterGroups: Array + /** The maximum results to return, up to 200 objects. */ + limit: number + /** A list of property names to include in the response. */ + properties: Array + /** The search query string, up to 3000 characters. */ + query?: string + /** Specifies sorting order based on object properties. */ + sorts: Array +} + +/** Represents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning. */ +export type PublicObjectWarning = { + /** The classification of the warning, indicating the type or nature of the issue. */ + category: string + /** Additional information or metadata about the warning, providing context for understanding the issue. */ + context: { [key: string]: string } + /** The text of the warning message, providing information about the issue or alert. */ + message: string +} + +/** A simple public object. */ +export type SimplePublicObject = { + /** Whether the object is archived. */ + archived: boolean + /** The timestamp when the object was archived, in ISO 8601 format. */ + archivedAt?: string + /** The timestamp when the object was created, in ISO 8601 format. */ + createdAt: string + /** The unique ID of the object. */ + id: string + /** An identifier used to trace the write request for the object. Set a unique ID for each write operation; it is returned with any errors so you can identify which request encountered which error. */ + objectWriteTraceId?: string + /** Key-value pairs representing the properties of the object. */ + properties: { [key: string]: string } + /** Key-value pairs representing the properties of the object along with their history, each with a timestamp and source information. */ + propertiesWithHistory?: { [key: string]: Array } + /** The timestamp when the object was last updated, in ISO 8601 format. */ + updatedAt: string + /** The URL associated with the object. */ + url?: string + warnings?: Array +} + +/** Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties. */ +export type SimplePublicObjectBatchInput = { + /** The ID of the contact to update. This can be the object ID, or the unique property value of the `idProperty` property. */ id: string - text: string - author: string - created_at: string + /** The name of a unique property, when identifying records by property. */ + idProperty?: string + /** A unique identifier for tracing the request. */ + objectWriteTraceId?: string + /** Key-value pairs representing the properties of the object. */ + properties: { [key: string]: string } } -export type CommentList = { - results: Array - has_more: boolean - next_cursor?: string | null +/** An input object that contains a collection of objects to be created together in a batch. */ +export type SimplePublicObjectBatchInputForCreate = { + /** An array of associations that define the relationships between the objects being created and other existing objects. This property is required. */ + associations: Array + /** An identifier used for tracing the creation or update request of the object. */ + objectWriteTraceId?: string + /** Key value pairs representing the properties of the object. */ + properties: { [key: string]: string } +} + +/** Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID. */ +export type SimplePublicObjectBatchInputUpsert = { + /** The unique ID of the object. */ + id: string + /** The name of a property whose values are unique for this object */ + idProperty?: string + /** An identifier for tracing the creation request. */ + objectWriteTraceId?: string + /** Key value pairs representing the properties of the object. */ + properties: { [key: string]: string } +} + +/** Contains the Id of a Public Object */ +export type SimplePublicObjectId = { + /** The unique ID of the object. */ + id: string +} + +/** Represents the input required to update a CRM object, containing an object with property names and their corresponding values. */ +export type SimplePublicObjectInput = { + /** Key value pairs representing the properties of the object. */ + properties: { [key: string]: string } +} + +/** Is the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects. */ +export type SimplePublicObjectInputForCreate = { + /** An array that specifies the relationships between the new public object and existing objects. This is required to establish how the new object is connected within the system. */ + associations: Array + /** Key-value pairs for setting properties for the new object. */ + properties: { [key: string]: string } +} + +/** Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type. */ +export type SimplePublicObjectWithAssociations = { + /** Whether the object is archived. */ + archived: boolean + /** The timestamp when the object was archived, in ISO 8601 format. */ + archivedAt?: string + /** A map of associated object types to their associated IDs. */ + associations?: { [key: string]: CollectionResponseAssociatedId } + /** The timestamp when the object was created, in ISO 8601 format. */ + createdAt: string + /** The unique ID of the object. */ + id: string + /** An identifier used for tracing the creation or update request of the object. */ + objectWriteTraceId?: string + /** Key value pairs representing the properties of the object. */ + properties: { [key: string]: string } + /** Key-value pairs representing the properties of the object along with their history. */ + propertiesWithHistory?: { [key: string]: Array } + /** The timestamp when the object was last updated, in ISO 8601 format. */ + updatedAt: string + /** The URL link to access this object. */ + url?: string + warnings?: Array } + +/** Represents a CRM object that has either been created or updated (upserted) */ +export type SimplePublicUpsertObject = { + /** Whether the object is archived. */ + archived: boolean + /** The timestamp when the object was archived, in ISO 8601 format. */ + archivedAt?: string + /** The timestamp when the object was created, in ISO 8601 format. */ + createdAt: string + /** The unique ID of the object. */ + id: string + /** Whether the property is new. */ + new: boolean + /** An identifier for tracing the creation request. */ + objectWriteTraceId?: string + /** Key value pairs representing the properties of the object. */ + properties: { [key: string]: string } + /** Key-value pairs representing the properties of the object along with their history. */ + propertiesWithHistory?: { [key: string]: Array } + /** The timestamp when the object was last updated, in ISO 8601 format. */ + updatedAt: string + /** The URL associated with the object. */ + url?: string + warnings?: Array +} + +/** Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request. */ +export type StandardError = { + /** The main category of the error. */ + category: string + /** Additional context-specific information related to the error. */ + context: { [key: string]: Array } + /** The detailed error objects. */ + errors: Array + /** A unique ID for the error instance. */ + id?: string + /** URLs linking to documentation or resources associated with the error. */ + links: { [key: string]: string } + /** A human-readable string describing the error and possible remediation steps. */ + message: string + /** A text status code for the error, typically "error". */ + status: string + /** A more specific error category within each main category. */ + subCategory?: Record +} + +/** Property model that includes timestamp. */ +export type ValueWithTimestamp = { + /** A string identifier for the specific source of the value. */ + sourceId?: string + /** A human-readable label. */ + sourceLabel?: string + /** A string indicating the type of source from which the value originated. */ + sourceType: string + /** The timestamp when the property was updated, in ISO 8601 format. */ + timestamp: string + /** The ID of the user who last updated the property. */ + updatedByUserId?: number + /** The property value. */ + value: string +} + +export type CollectionResponsePublicOwnerForwardPaging = { + paging?: ForwardPaging + /** An array of PublicOwner objects, each representing an individual owner with their specific details. */ + results: Array +} + +export type PublicOwner = { + /** Indicates whether the owner is archived. */ + archived: boolean + /** The date and time when the owner was created. */ + createdAt: string + /** The email address of the owner. */ + email?: string + /** The first name of the owner. */ + firstName?: string + /** The unique identifier of the owner. */ + id: string + /** The last name of the owner. */ + lastName?: string + /** An array of teams associated with the owner, where each team is represented by a PublicTeam object. */ + teams?: Array + /** The type of the owner, which can be either PERSON or QUEUE. */ + type: "PERSON" | "QUEUE" + /** The date and time when the owner was last updated. */ + updatedAt: string + /** The user ID of the owner. */ + userId?: number + /** The user ID of the owner, including inactive users. */ + userIdIncludingInactive?: number +} + +export type PublicTeam = { + /** The unique identifier for the team, represented as a string. */ + id: string + /** The name of the team, represented as a string. */ + name: string + /** A boolean indicating whether this team is the primary team. */ + primary: boolean +} + +export type CollectionResponsePipelineNoPaging = { + results: Array +} + +export type CollectionResponsePipelineStageNoPaging = { + results: Array +} + +export type CollectionResponsePublicAuditInfoNoPaging = { + results: Array +} + +export type Pipeline = { + /** Whether the pipeline is archived. */ + archived: boolean + /** The date the pipeline was archived. `archivedAt` will only be present if the pipeline is archived. */ + archivedAt?: string + /** The date the pipeline was created. The default pipelines will have createdAt = 0. */ + createdAt: string + /** The order for displaying this pipeline. If two pipelines have a matching `displayOrder`, they will be sorted alphabetically by label. */ + displayOrder: number + /** A unique identifier generated by HubSpot that can be used to retrieve and update the pipeline. */ + id: string + /** A unique label used to organize pipelines in HubSpot's UI */ + label: string + /** The stages associated with the pipeline. They can be retrieved and updated via the pipeline stages endpoints. */ + stages: Array + /** The date the pipeline was last updated. */ + updatedAt: string +} + +export type PipelineInput = { + /** The order for displaying this pipeline. If two pipelines have a matching `displayOrder`, they will be sorted alphabetically by label. */ + displayOrder: number + /** A unique label used to organize pipelines in HubSpot's UI */ + label: string + pipelineId?: string + /** Pipeline stage inputs used to create the new or replacement pipeline. */ + stages: Array +} + +export type PipelinePatchInput = { + /** Whether the pipeline is archived. This property should only be provided when restoring an archived pipeline. If it's provided in any other call, the request will fail and a `400 Bad Request` will be returned. */ + archived?: boolean + /** The order for displaying this pipeline. If two pipelines have a matching `displayOrder`, they will be sorted alphabetically by label. */ + displayOrder?: number + /** A unique label used to organize pipelines in HubSpot's UI */ + label?: string +} + +export type PipelineReplaceInput = { + /** The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label. */ + displayOrder: number + /** A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline. */ + label: string + /** The stages associated with the pipeline. They can be retrieved and updated via the pipeline stages endpoints. */ + stages: Array +} + +export type PipelineStage = { + /** Whether the pipeline is archived. */ + archived: boolean + /** The date the pipeline was archived. `archivedAt` will only be present if the pipeline is archived. */ + archivedAt?: string + /** The date the pipeline stage was created. The stages on default pipelines will have createdAt = 0. */ + createdAt: string + /** The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label. */ + displayOrder: number + /** A unique identifier generated by HubSpot that can be used to retrieve and update the pipeline stage. */ + id: string + /** A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline. */ + label: string + /** A JSON object containing properties that are not present on all object pipelines. For `deals` pipelines, the `probability` field is required (`{ "probability": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1. For `tickets` pipelines, the `ticketState` field is optional (`{ "ticketState": "OPEN" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`. */ + metadata: { [key: string]: string } + /** The date the pipeline stage was last updated. */ + updatedAt: string + /** Defines the level of write access for the pipeline stage, with possible values being CRM_PERMISSIONS_ENFORCEMENT, READ_ONLY, or INTERNAL_ONLY. */ + writePermissions: "CRM_PERMISSIONS_ENFORCEMENT" | "INTERNAL_ONLY" | "READ_ONLY" +} + +export type PipelineStageInput = { + /** The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label. */ + displayOrder: number + /** A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline. */ + label: string + /** A JSON object containing properties that are not present on all object pipelines. For `deals` pipelines, the `probability` field is required (`{ "probability": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1. For `tickets` pipelines, the `ticketState` field is optional (`{ "ticketState": "OPEN" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`. */ + metadata: { [key: string]: string } + stageId?: string +} + +export type PipelineStagePatchInput = { + /** Whether the pipeline is archived. */ + archived?: boolean + /** The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label. */ + displayOrder?: number + /** A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline. */ + label?: string + /** A JSON object containing properties that are not present on all object pipelines. For `deals` pipelines, the `probability` field is required (`{ "probability": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1. For `tickets` pipelines, the `ticketState` field is optional (`{ "ticketState": "OPEN" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`. */ + metadata: { [key: string]: string } +} + +export type PipelineStageReplaceInput = { + /** The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label. */ + displayOrder: number + /** A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline. */ + label: string + /** A JSON object containing properties that are not present on all object pipelines. For `deals` pipelines, the `probability` field is required (`{ "probability": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1. For `tickets` pipelines, the `ticketState` field is optional (`{ "ticketState": "OPEN" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`. */ + metadata: { [key: string]: string } +} + +export type PublicAuditInfo = { + /** The action performed that triggered the audit event. */ + action: string + /** The ID of the user who initiated the audit event. */ + fromUserId?: number + /** A unique string identifier for the audit event. */ + identifier: string + /** A descriptive message related to the audit event. */ + message?: string + /** The unique identifier for the HubSpot portal where the audit event occurred. */ + portalId: number + /** An object containing the raw data associated with the audit event. */ + rawObject?: Record + /** The date and time when the audit event took place. */ + timestamp?: string +} + +export type BatchInputPropertyCreate = { + /** An array of PropertyCreate objects, each representing a property to be created. This field is required. */ + inputs: Array +} + +export type BatchInputPropertyName = { + /** An array of property names to be processed in the batch operation. Each item in the array is a reference to a PropertyName object. */ + inputs: Array +} + +export type BatchReadInputPropertyName = { + /** Specifies whether the property is archived. */ + archived: boolean + /** Indicates the sensitivity level of the data, such as 'non_sensitive', 'sensitive', or 'highly_sensitive'. */ + dataSensitivity: "highly_sensitive" | "non_sensitive" | "sensitive" + /** An array of property names to be included in the batch read operation. Each item in the array is a reference to a PropertyName object. */ + inputs: Array +} + +export type BatchResponseProperty = { + /** The timestamp indicating when the batch operation was completed. */ + completedAt: string + /** A collection of URLs linking to documentation or resources related to the batch operation. */ + links?: { [key: string]: string } + /** The timestamp indicating when the batch operation was requested. */ + requestedAt?: string + /** An array of Property objects representing the results of the batch operation. */ + results: Array + /** The timestamp indicating when the batch operation began processing. */ + startedAt: string + /** The current status of the batch operation, with possible values being CANCELED, COMPLETE, PENDING, or PROCESSING. */ + status: "CANCELED" | "COMPLETE" | "PENDING" | "PROCESSING" +} + +export type BatchResponsePropertyWithErrors = { + /** The date and time when the batch operation was completed, in ISO 8601 format. */ + completedAt: string + /** An array of errors encountered during the batch operation, each represented by a StandardError object. */ + errors?: Array + /** A map of link names to their associated URIs, providing additional information or actions related to the batch operation. */ + links?: { [key: string]: string } + /** The number of errors encountered during the batch operation. */ + numErrors?: number + /** The date and time when the batch operation was requested, in ISO 8601 format. */ + requestedAt?: string + /** An array of properties that were processed in the batch operation. */ + results: Array + /** The date and time when the batch operation started, in ISO 8601 format. */ + startedAt: string + /** The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. */ + status: "CANCELED" | "COMPLETE" | "PENDING" | "PROCESSING" +} + +export type CollectionResponsePropertyGroupNoPaging = { + /** An array of property groups, where each group is represented by a PropertyGroup object. */ + results: Array +} + +export type CollectionResponsePropertyNoPaging = { + /** An array of Property objects, each representing a specific property associated with the object type. This array contains the details of each property such as name, label, type, and other metadata. */ + results: Array +} + +/** A HubSpot property option */ +export type Option = { + /** A description of the option. */ + description?: string + /** Options are displayed in order starting with the lowest positive integer value. Values of -1 will cause the option to be displayed after any positive values. */ + displayOrder?: number + /** Hidden options will not be displayed in HubSpot. */ + hidden: boolean + /** A human-readable option label that will be shown in HubSpot. */ + label: string + /** The internal value of the option, which must be used when setting the property value through the API. */ + value: string +} + +export type OptionInput = { + /** A description of the option. */ + description?: string + /** Options are shown in order starting with the lowest positive integer value. Values of -1 will cause the option to be displayed after any positive values. */ + displayOrder: number + /** Hidden options won't be shown in HubSpot. */ + hidden: boolean + /** A human-readable option label that will be shown in HubSpot. */ + label: string + /** The internal value of the option, which must be used when setting the property value through the API. */ + value: string +} + +/** A HubSpot property */ +export type Property = { + /** Whether or not the property is archived. */ + archived?: boolean + /** When the property was archived. */ + archivedAt?: string + /** For default properties, true indicates that the property is calculated by a HubSpot process. It has no effect for custom properties. */ + calculated?: boolean + /** Represents a formula that is used to compute a calculated property. */ + calculationFormula?: string + /** The timestamp when the property was created, in ISO 8601 format. */ + createdAt?: string + /** The internal user ID of the user who created the property in HubSpot. This field may not exist if the property was created outside of HubSpot. */ + createdUserId?: string + /** The name of the currency property associated with this property, if applicable. */ + currencyPropertyName?: string + /** The sensitivity level of the data. Valid values include 'non_sensitive', 'sensitive', and 'highly_sensitive'. */ + dataSensitivity?: "highly_sensitive" | "non_sensitive" | "sensitive" + /** Indicates how date values should be displayed, with options such as 'absolute', 'absolute_with_relative', 'time_since', or 'time_until'. */ + dateDisplayHint?: "absolute" | "absolute_with_relative" | "time_since" | "time_until" + /** A description of the property that will be shown as help text in HubSpot. */ + description: string + /** Properties are shown in order, starting with the lowest positive integer value. */ + displayOrder?: number + /** For default properties, true indicates that the options are stored externally to the property settings. */ + externalOptions?: boolean + /** Controls how the property appears in HubSpot. */ + fieldType: string + /** Whether or not the property can be used in a HubSpot form. */ + formField?: boolean + /** The name of the property group the property belongs to. */ + groupName: string + /** Whether or not the property's value must be unique. Once set, this can't be changed. */ + hasUniqueValue?: boolean + /** Whether or not the property will be hidden from the HubSpot UI. It's recommended this be set to false for custom properties. */ + hidden?: boolean + /** This will be true for default object properties built into HubSpot. */ + hubspotDefined?: boolean + /** A human-readable property label that will be shown in HubSpot. */ + label: string + modificationMetadata?: PropertyModificationMetadata + /** The internal property name, which must be used when referencing the property via the API. */ + name: string + /** A hint for displaying number properties. Valid values include 'unformatted', 'formatted', 'currency', 'percentage', 'duration', and 'probability'. */ + numberDisplayHint?: "currency" | "duration" | "formatted" | "percentage" | "probability" | "unformatted" + /** A list of valid options for the property. This field is required for enumerated properties, but will be empty for other property types. */ + options: Array