Skip to main content
POST
/
crm
/
objects
/
v3
/
deals
/
splits
/
batch
/
upsert
Create or replace deal splits for deals with the provided IDs. Deal split percentages for each deal must sum up to 1.0 (100%) and may have up to 8 decimal places
curl --request POST \
  --url https://api.hubapi.com/crm/objects/v3/deals/splits/batch/upsert \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    {
      "id": 123,
      "splits": [
        {
          "ownerId": 123,
          "percentage": 123
        }
      ]
    }
  ]
}
'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "id": "<string>",
      "splits": [
        {
          "archived": true,
          "createdAt": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "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",
  "errors": [
    {
      "category": "<string>",
      "context": {},
      "errors": [
        {
          "message": "<string>",
          "code": "<string>",
          "context": "{missingScopes=[scope1, scope2]}",
          "in": "<string>",
          "subCategory": "<string>"
        }
      ],
      "links": {},
      "message": "<string>",
      "status": "<string>",
      "id": "<string>",
      "subCategory": {}
    }
  ],
  "links": {},
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z"
}

Supported products

Authorizations

Authorization
string
header
required

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

Body

application/json
inputs
object[]
required

An array of deal split inputs

Response

successful operation

completedAt
string<date-time>
required

The timestamp indicating when the batch operation was completed, in date-time format.

results
object[]
required

An array of deal-to-deal split objects representing the results of the batch operation.

startedAt
string<date-time>
required

The timestamp indicating when the batch operation started, in date-time format.

status
enum<string>
required

The current status of the batch operation, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING.

Available options:
CANCELED,
COMPLETE,
PENDING,
PROCESSING
errors
object[]

A map of link names to associated URIs for additional resources or documentation.

numErrors
integer<int32>
requestedAt
string<date-time>

The timestamp indicating when the batch operation was requested, in date-time format.

Last modified on March 30, 2026