Search + K

Command Palette

Search for a command to run...

Sign In

Update a batch of services by internal ID, or unique property values

POST /crm/v3/objects/0-162/batch/update
Copy endpoint
https://api.hubapi.com

Update a batch of objects

Request Body

application/json required
interface BatchInputSimplePublicObjectBatchInput {
inputs: SimplePublicObjectBatchInput

Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties.

interface SimplePublicObjectBatchInput {
id: string;
idProperty?: string;
objectWriteTraceId?: string;
properties: { };
}
[]
;
}

Responses

200 application/json

successful operation

interface BatchResponseSimplePublicObject29 {
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: SimplePublicObject31

A simple public object.

interface SimplePublicObject31 {
archived: boolean;
archivedAt?: string;
createdAt: string;
id: string;
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;
}