Create or update a batch of services by unique property values

POST /crm/v3/objects/0-162/batch/upsert

Copy endpoint

https://api.hubapi.com

Create or update records identified by a unique property value as specified by the idProperty query param. idProperty query param refers to a property whose values are unique for the object.

Request Body

application/json required

interface BatchInputSimplePublicObjectBatchInputUpsert {
inputs:

SimplePublicObjectBatchInputUpsert

Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID.

interface SimplePublicObjectBatchInputUpsert {
id: string;
idProperty?: string;
objectWriteTraceId?: string;
properties: { };
}

[];
}

Responses

200 application/json

successful operation

interface BatchResponseSimplePublicUpsertObject24 {
completedAt: string;
errors?:

StandardError

Ye olde error

interface StandardError {
category: string;
context: { };
errors: ErrorDetail[];
id?: string;
links: { };
message: string;
status: string;
subCategory?: {};
}

[];
links?: { };
numErrors?: number;
requestedAt?: string;
results:

SimplePublicUpsertObject24

Represents a CRM object that has either been created or updated (upserted)

interface SimplePublicUpsertObject24 {
archived: boolean;
archivedAt?: string;
createdAt: string;
id: string;
new: boolean;
objectWriteTraceId?: string;
properties: { };
propertiesWithHistory?: { };
updatedAt: string;
}

[];
startedAt: string;
status: "CANCELED" | "COMPLETE" | "PENDING" | "PROCESSING";
}

default */*

An error occurred.

interface Error {
category: string;
context?: { };
correlationId: string;
errors?:

ErrorDetail

interface ErrorDetail {
code?: string;
context?: { };
in?: string;
message: string;
subCategory?: string;
}

[];
links?: { };
message: string;
subCategory?: string;
}