Create or update a batch of tasks by unique property values

Crie ou atualize registros identificados por um valor de propriedade exclusivo conforme especificado pelo parâmetro de consulta “idProperty”. Esse parâmetro de consulta refere-se a uma propriedade cujos valores são exclusivos para o objeto.

POST /crm/v3/objects/tasks/batch/upsert

Criar ou atualizar um lote de tarefas por valores de propriedades exclusivas

cURL

curl --request POST \
  --url https://api.hubapi.com/crm/v3/objects/tasks/batch/upsert \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    {
      "id": "<string>",
      "properties": {},
      "idProperty": "<string>",
      "objectWriteTraceId": "<string>"
    }
  ]
}
'

200

{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "archived": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "new": true,
      "properties": {},
      "updatedAt": "2023-11-07T05:31:56Z",
      "archivedAt": "2023-11-07T05:31:56Z",
      "objectWriteTraceId": "<string>",
      "propertiesWithHistory": {},
      "url": "<string>"
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "links": {},
  "requestedAt": "2023-11-07T05:31:56Z"
}

Supported products

Required Scopes

Autorizações

Authorization · string · header · obrigatório

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

Corpo

application/json

inputs · object[] · obrigatório

Show child attributes

Resposta

200

application/json

successful operation

Representa o resultado de uma operação de upsert em lote, incluindo o status da operação, carimbos de data/hora e uma lista de objetos criados ou atualizados com sucesso.

completedAt · string<date-time> · obrigatório

A data e hora em que o processo em lote foi concluído, no formato ISO 8601.

results · object[] · obrigatório

Show child attributes

startedAt · string<date-time> · obrigatório

A data e hora em que o processamento em lote começou a ser executado, no formato ISO 8601.

status · enum<string> · obrigatório

O status da solicitação de processamento em lote. Pode ser: "PENDENTE", "PROCESSANDO", "CANCELADO" ou "CONCLUÍDO"

Opções disponíveis: CANCELED, COMPLETE, PENDING, PROCESSING

links · object

Um objeto contendo links relevantes relacionados à solicitação em lote.

Show child attributes

requestedAt · string<date-time>

A data e hora em que o processo em lote foi iniciado, no formato ISO 8601.