Skip to main content
POST
/
crm
/
objects
/
v3
/
{objectType}
/
batch
/
upsert
Crea o actualiza un lote de citas por valores de propiedad únicos
curl --request POST \
  --url https://api.hubapi.com/crm/objects/v3/{objectType}/batch/upsert \
  --header 'Content-Type: application/json' \
  --header 'private-app: <api-key>' \
  --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": {},
      "url": "<string>",
      "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"
}

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing Hub -Gratuito
Sales HubSales Hub -Gratuito
Service HubService Hub -Gratuito
Content HubContent Hub -Gratuito
Esta API requiere uno de los siguientes ámbitos:
crm.objects.appointments.read
crm.objects.appointments.sensitive.read.v2
crm.objects.appointments.sensitive.write.v2
crm.objects.appointments.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.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.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.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.quotes.read
crm.objects.quotes.write
crm.objects.services.read
crm.objects.services.write
crm.objects.subscriptions.read
crm.objects.subscriptions.write
crm.objects.users.read
crm.objects.users.write
e-commerce
media_bridge.read
oauth
tickets
tickets.highly_sensitive.v2
tickets.sensitive.v2

Authorizations

​
private-app
string
header
required

Path Parameters

​
objectType
string
required

objectTypeId del tipo de objeto

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

Número de errores.

​
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[]