> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.jp/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Archive
> Move an Object identified by `{communicationId}` to the recycling bin.
export const ScopesList = ({scopes = [], description = "この API には、次のいずれかのスコープが必要です。"}) => {
if (!scopes || scopes.length === 0) {
return null;
}
const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
return
;
};
## OpenAPI
````yaml specs/legacy/v3/crm-communications-v3.json DELETE /crm/v3/objects/communications/{communicationId}
openapi: 3.0.1
info:
title: Communications
description: >-
CRM objects such as companies, contacts, deals, line items, products,
tickets, and quotes are standard objects in HubSpot’s CRM. These core
building blocks support custom properties, store critical information, and
play a central role in the HubSpot application.
## Supported Object Types
This API provides access to collections of CRM objects, which return a map
of property names to values. Each object type has its own set of default
properties, which can be found by exploring the [CRM Object Properties
API](https://developers.hubspot.com/docs/methods/crm-properties/crm-properties-overview).
|Object Type |Properties returned by default |
|--|--|
| `companies` | `name`, `domain` |
| `contacts` | `firstname`, `lastname`, `email` |
| `deals` | `dealname`, `amount`, `closedate`, `pipeline`, `dealstage` |
| `products` | `name`, `description`, `price` |
| `tickets` | `content`, `hs_pipeline`, `hs_pipeline_stage`,
`hs_ticket_category`, `hs_ticket_priority`, `subject` |
Find a list of all properties for an object type using the [CRM Object
Properties](https://developers.hubspot.com/docs/methods/crm-properties/get-properties)
API. e.g. `GET https://api.hubapi.com/properties/v2/companies/properties`.
Change the properties returned in the response using the `properties` array
in the request body.
version: v3
x-hubspot-product-tier-requirements:
marketing: FREE
sales: FREE
service: FREE
cms: FREE
commerce: FREE
crmHub: FREE
dataHub: FREE
x-hubspot-api-use-case: >-
Your team frequently reaches out to your contacts via multiple channels that
aren't directly connected to your HubSpot account, and you want to ensure
all your communications to customers are centralized in one place.
x-hubspot-related-documentation:
- name: Communications Guide
url: >-
https://developers.hubspot.com/docs/guides/api/crm/engagements/communications
x-hubspot-introduction: >-
Use the communications API to associate messages from external channels
(e.g., WhatsApp, LinkedIn, and SMS) to CRM records in your HubSpot account.
servers:
- url: https://api.hubapi.com
security: []
tags:
- name: Basic
- name: Batch
- name: Search
paths:
/crm/v3/objects/communications/{communicationId}:
delete:
tags:
- Basic
summary: Archive
description: Move an Object identified by `{communicationId}` to the recycling bin.
operationId: delete-/crm/v3/objects/communications/{communicationId}_archive
parameters:
- name: communicationId
in: path
required: true
schema:
pattern: .+
type: string
responses:
'204':
description: No content
content: {}
default:
$ref: '#/components/responses/Error'
description: ''
security:
- oauth2:
- crm.objects.contacts.write
components:
responses:
Error:
description: An error occurred.
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
schemas:
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
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
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://app.hubspot.com/oauth/authorize
tokenUrl: https://api.hubapi.com/oauth/v1/token
scopes:
crm.objects.commercepayments.read: ''
crm.objects.contacts.read: ''
crm.objects.contacts.write: ''
oauth: ''
````
{product.name} -
{product.level}
)}