Zum Hauptinhalt springen
POST
/
crm
/
v3
/
objects
/
{objectType}
/
batch
/
upsert
Créer ou mettre à jour un lot d'objets par des valeurs de propriété uniques
curl --request POST \
  --url https://api.hubapi.com/crm/v3/objects/{objectType}/batch/upsert \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "inputs": [
    {
      "idProperty": "<string>",
      "objectWriteTraceId": "<string>",
      "id": "<string>",
      "properties": {}
    }
  ]
}'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "links": {},
  "results": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "archived": true,
      "archivedAt": "2023-11-07T05:31:56Z",
      "new": true,
      "propertiesWithHistory": {},
      "id": "<string>",
      "objectWriteTraceId": "<string>",
      "properties": {},
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "errors": [
    {
      "subCategory": {},
      "context": {},
      "links": {},
      "id": "<string>",
      "category": "<string>",
      "message": "<string>",
      "errors": [
        {
          "subCategory": "<string>",
          "code": "<string>",
          "in": "<string>",
          "context": "{\"missingScopes\":[\"scope1\",\"scope2\"]}",
          "message": "<string>"
        }
      ],
      "status": "<string>"
    }
  ],
  "status": "PENDING"
}
Produits pris en charge
Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing HubGratuit
Sales HubSales HubGratuit
Service HubService HubGratuit
Content HubContent HubGratuit

​
Portées requises

Cette API requiert l’une des portées suivantes :
  • crm.objects.orders.read
  • crm.objects.appointments.sensitive.read.v2
  • crm.objects.contacts.highly_sensitive.read.v2
  • crm.objects.companies.write
  • crm.objects.custom.sensitive.read.v2
  • crm.objects.users.read
  • crm.objects.users.write
  • crm.objects.commercepayments.write
  • crm.objects.invoices.write
  • crm.objects.contacts.highly_sensitive.write.v2
  • crm.objects.carts.write
  • crm.objects.appointments.write
  • crm.objects.partner-services.read
  • crm.objects.custom.write
  • tickets
  • crm.objects.deals.sensitive.write.v2
  • oauth
  • crm.objects.deals.highly_sensitive.write.v2
  • crm.objects.companies.highly_sensitive.write.v2
  • tickets.sensitive.v2
  • crm.objects.appointments.read
  • crm.objects.appointments.sensitive.write.v2
  • media_bridge.read
  • crm.objects.listings.read
  • crm.objects.courses.write
  • crm.objects.carts.read
  • crm.objects.listings.write
  • crm.objects.custom.read
  • crm.objects.deals.read
  • crm.objects.subscriptions.read
  • crm.objects.companies.sensitive.read.v2
  • crm.objects.companies.read
  • crm.objects.custom.sensitive.write.v2
  • crm.objects.deals.highly_sensitive.read.v2
  • crm.objects.contacts.sensitive.write.v2
  • crm.objects.companies.highly_sensitive.read.v2
  • crm.objects.partner-services.write
  • crm.objects.contacts.read
  • crm.objects.services.write
  • crm.objects.orders.write
  • crm.objects.subscriptions.write
  • crm.objects.commercepayments.read
  • crm.objects.products.write
  • crm.objects.custom.highly_sensitive.read.v2
  • crm.objects.deals.write
  • crm.objects.invoices.read
  • e-commerce
  • tickets.highly_sensitive.v2
  • crm.objects.quotes.write
  • crm.objects.leads.read
  • crm.objects.leads.write
  • crm.objects.custom.highly_sensitive.write.v2
  • crm.objects.deals.sensitive.read.v2
  • crm.objects.goals.write
  • crm.objects.companies.sensitive.write.v2
  • crm.objects.contacts.write
  • crm.objects.goals.read
  • crm.objects.partner-clients.write
  • crm.objects.line_items.read
  • crm.objects.contacts.sensitive.read.v2
  • crm.objects.line_items.write
  • crm.objects.products.read
  • crm.objects.courses.read
  • crm.objects.quotes.read
  • crm.objects.partner-clients.read
  • crm.objects.services.read

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
objectType
string
required

Body

application/json
​
inputs
object[]
required

Response

successful operation

Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.

​
completedAt
string<date-time>
required

The timestamp when the batch process was completed, in ISO 8601 format.

​
startedAt
string<date-time>
required

The timestamp when the batch process began execution, in ISO 8601 format.

​
results
object[]
required
​
status
enum<string>
required

The status of the batch processing request. Can be: "PENDING", "PROCESSING", "CANCELED", or "COMPLETE".

Available options:
PENDING,
PROCESSING,
CANCELED,
COMPLETE
​
numErrors
integer
​
requestedAt
string<date-time>

The timestamp when the batch process was initiated, in ISO 8601 format.

​
links
object

An object containing relevant links related to the batch request.

​
errors
object[]
⌘I