Batch

A group of records (Prospect, Account, etc.) in which the same particular action was performed.

action	string <= 255 characters Action performed on the batch.
canceledAt	string <date-time> The date and time the batch was canceled.
confirmCount	integer The number of items in the batch to be confirmed.
confirmedAt	string <date-time> The date and time the batch was confirmed.
confirmedCountRequired	boolean Require the user to explicitly confirm the confirm_count.
createdAt	string <date-time> The date and time the batch was created.
externalStartPayload	string <= 16777215 characters Optional parameter used to handle external batch operations
failures	integer The number of failed batch items associated with this batch.
finishedAt	string <date-time> The date and time the batch was finished.
payload	object The input payload for the batch operation.
pending	integer The number of pending batch items associated with this batch.
startedAt	string <date-time> The date and time the batch was started.
state	string <= 255 characters The current state of the batch.
summary	object The summary of the batch including failure information.
total	integer The total number of batch items associated with this batch.
updatedAt	string <date-time> The date and time the batch was last updated.

{"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
}

Batch Relationships

Array of links (object) (batchItem)

The batch items associated with this batch.

{"batchItems": [{"links": {"related": "batchItem"
}
}
]
}

Batch Resource Metadata

METADATA NAME	DESCRIPTION	QUERY PARAM
canWrite	A boolean value indicating whether the current API user has write access to this resource.	provideAuthorizationMeta

⌵ Batch Actions

Get a Collection of Batches

SecuritybearerAuth

Responses

200

422

JSON error message

get/batches

Request samples

curl
JavaScript
Python
Go
Java

Response samples

application/vnd.api+json

{"data": [{"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
]
}

Create a New Batch

SecuritybearerAuth

Request

Request Body schema: application/vnd.api+json
required

object

Responses

201

Created

422

JSON error message

post/batches

Request samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Get a Batch by ID

SecuritybearerAuth

Request

path Parameters

required

integer

Responses

200

404

Not Found

get/batches/{id}

Request samples

curl
JavaScript
Python
Go
Java

Response samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Update a Batch

SecuritybearerAuth

Request

path Parameters

required

integer

Request Body schema: application/vnd.api+json
required

object

Responses

200

422

JSON error message

patch/batches/{id}

Request samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Account Add Tags

Bulk Action

Adds tags to the accounts targeted by the query parameters (default: ALL) using the {tags} array of strings passed in request body

SecuritybearerAuth

Request

query Parameters

object

Request Body schema: application/vnd.api+json

	object
type	string

Responses

200

422

JSON error message

post/batches/actions/accountAddTags

Request samples

application/vnd.api+json

{"data": {"attributes": {"ids": ["string"
],
"tags": ["string"
]
}
},
"type": "string"
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Accounts Add Assignments

Bulk Action

Adds assignments to the accounts targeted by the query parameters (default: ALL) using the {userIds} array of strings passed in request body

SecuritybearerAuth

Request

query Parameters

object

Request Body schema: application/vnd.api+json

	object
type	string

Responses

200

422

JSON error message

post/batches/actions/accountsAddAssignments

Request samples

application/vnd.api+json

{"data": {"attributes": {"ids": ["string"
],
"userIds": ["string"
]
}
},
"type": "string"
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Accounts Assign Owner

Bulk Action

assign an user with {ownerId} as owner to all the targeted accounts

SecuritybearerAuth

Request

query Parameters

object

Request Body schema: application/vnd.api+json

	object
type	string

Responses

200

422

JSON error message

post/batches/actions/accountsAssignOwner

Request samples

application/vnd.api+json

{"data": {"attributes": {"ids": ["string"
],
"ownerId": 0
}
},
"type": "string"
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Accounts Bulk Modify

Bulk Action

Modifies the accounts targeted by the query parameters (default: ALL) using the {field, value} pair passed in request body

SecuritybearerAuth

Request

query Parameters

object

Request Body schema: application/vnd.api+json

	object
type	string

Responses

200

422

JSON error message

post/batches/actions/accountsBulkModify

Request samples

application/vnd.api+json

{"data": {"attributes": {"fieldName": "string",
"fieldValue": "string",
"ids": ["string"
]
}
},
"type": "string"
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Accounts Destroy All

Bulk Action

Deletes the accounts targeted by the query parameters (default: ALL)

SecuritybearerAuth

Request

query Parameters

object

Request Body schema: application/vnd.api+json

	object
type	string

Responses

200

422

JSON error message

post/batches/actions/accountsDestroyAll

Request samples

application/vnd.api+json

{"data": {"attributes": {"ids": ["string"
]
}
},
"type": "string"
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Accounts Remove All Assignments

Bulk Action

Removes all assignments from the accounts targeted by the query parameters (default: ALL)

SecuritybearerAuth

Request

query Parameters

object

Request Body schema: application/vnd.api+json

	object
type	string

Responses

200

422

JSON error message

post/batches/actions/accountsRemoveAllAssignments

Request samples

application/vnd.api+json

{"data": {"attributes": {"ids": ["string"
]
}
},
"type": "string"
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Accounts Remove Assignments

Bulk Action

Removes assignments from the accounts targeted by the query parameters (default: ALL) using the {userIds} array of strings passed in request body

SecuritybearerAuth

Request

query Parameters

object

Request Body schema: application/vnd.api+json

	object
type	string

Responses

200

422

JSON error message

post/batches/actions/accountsRemoveAssignments

Request samples

application/vnd.api+json

{"data": {"attributes": {"ids": ["string"
],
"userIds": ["string"
]
}
},
"type": "string"
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Accounts Remove Tags

Bulk Action

Removes tags from the accounts targeted by the query parameters (default: ALL) using the {tags} array of strings passed in request body

SecuritybearerAuth

Request

query Parameters

object

Request Body schema: application/vnd.api+json

	object
type	string

Responses

200

422

JSON error message

post/batches/actions/accountsRemoveTags

Request samples

application/vnd.api+json

{"data": {"attributes": {"ids": ["string"
],
"tags": ["string"
]
}
},
"type": "string"
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Prospects Add Assignments

Bulk Action

Adds assignments to the prospects targeted by the query parameters (default: ALL) using the {userIds} array of strings passed in request body

SecuritybearerAuth

Request

query Parameters

object

Request Body schema: application/vnd.api+json

	object
type	string

Responses

200

422

JSON error message

post/batches/actions/prospectsAddAssignments

Request samples

application/vnd.api+json

{"data": {"attributes": {"ids": ["string"
],
"userIds": ["string"
]
}
},
"type": "string"
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Prospects Add Tags

Bulk Action

Adds tags to the prospects targeted by the query parameters (default: ALL) using the {tags} array of strings passed in request body

SecuritybearerAuth

Request

query Parameters

object

Request Body schema: application/vnd.api+json

	object
type	string

Responses

200

422

JSON error message

post/batches/actions/prospectsAddTags

Request samples

application/vnd.api+json

{"data": {"attributes": {"ids": ["string"
],
"tags": ["string"
]
}
},
"type": "string"
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Prospects Add To Sequence

Bulk Action

Add Prospects To Sequence

SecuritybearerAuth

Request

query Parameters

object

Request Body schema: application/vnd.api+json

	object
type	string

Responses

200

422

JSON error message

post/batches/actions/prospectsAddToSequence

Request samples

application/vnd.api+json

{"data": {"attributes": {"ids": ["string"
],
"mailboxId": 0,
"sequenceId": 0
}
},
"type": "string"
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Prospects Assign Account

Bulk Action

Sets the account to the prospects targeted by the query parameters (default: ALL) using the {accountId} which specifies the account to add to the prospects

SecuritybearerAuth

Request

query Parameters

object

Request Body schema: application/vnd.api+json

	object
type	string

Responses

200

422

JSON error message

post/batches/actions/prospectsAssignAccount

Request samples

application/vnd.api+json

{"data": {"attributes": {"accountId": "string",
"ids": ["string"
]
}
},
"type": "string"
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Prospects Assign Opportunity

Bulk Action

Sets the opportunity to the prospects targeted by the query parameters (default: ALL) using the {opportunityId} which specifies the account to add to the prospects

SecuritybearerAuth

Request

query Parameters

object

Request Body schema: application/vnd.api+json

	object
type	string

Responses

200

422

JSON error message

post/batches/actions/prospectsAssignOpportunity

Request samples

application/vnd.api+json

{"data": {"attributes": {"ids": ["string"
],
"opportunityId": "string"
}
},
"type": "string"
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Prospects Assign Owner

Bulk Action

assign an user with {ownerId} as owner to all the targeted prospects

SecuritybearerAuth

Request

query Parameters

object

Request Body schema: application/vnd.api+json

	object
type	string

Responses

200

422

JSON error message

post/batches/actions/prospectsAssignOwner

Request samples

application/vnd.api+json

{"data": {"attributes": {"ids": ["string"
],
"ownerId": 0
}
},
"type": "string"
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Prospects Bulk Modify

Bulk Action

Modifies the prospects targeted by the query parameters (default: ALL) using the {field, value} pair passed in request body

SecuritybearerAuth

Request

query Parameters

object

Request Body schema: application/vnd.api+json

	object
type	string

Responses

200

422

JSON error message

post/batches/actions/prospectsBulkModify

Request samples

application/vnd.api+json

{"data": {"attributes": {"fieldName": "string",
"fieldValue": "string",
"ids": ["string"
]
}
},
"type": "string"
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Prospects Destroy All

Bulk Action

Deletes the prospects targeted by the query parameters (default: ALL)

SecuritybearerAuth

Request

query Parameters

object

Request Body schema: application/vnd.api+json

	object
type	string

Responses

200

422

JSON error message

post/batches/actions/prospectsDestroyAll

Request samples

application/vnd.api+json

{"data": {"attributes": {"ids": ["string"
]
}
},
"type": "string"
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Prospects Finish All

Bulk Action

For all prospects targeted by the query parameters (default: ALL), attempt to finish the associated prospect sequence

SecuritybearerAuth

Request

query Parameters

object

Request Body schema: application/vnd.api+json

	object
type	string

Responses

200

422

JSON error message

post/batches/actions/prospectsFinishAll

Request samples

application/vnd.api+json

{"data": {"attributes": {"ids": ["string"
]
}
},
"type": "string"
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Prospects Pause All

Bulk Action

For all prospects targeted by the query parameters (default: ALL), attempt to pause the associated prospect sequence

SecuritybearerAuth

Request

query Parameters

object

Request Body schema: application/vnd.api+json

	object
type	string

Responses

200

422

JSON error message

post/batches/actions/prospectsPauseAll

Request samples

application/vnd.api+json

{"data": {"attributes": {"ids": ["string"
]
}
},
"type": "string"
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Prospects Remove All Assignments

Bulk Action

Removes all assignments from the prospects targeted by the query parameters (default: ALL)

SecuritybearerAuth

Request

query Parameters

object

Request Body schema: application/vnd.api+json

	object
type	string

Responses

200

422

JSON error message

post/batches/actions/prospectsRemoveAllAssignments

Request samples

application/vnd.api+json

{"data": {"attributes": {"ids": ["string"
]
}
},
"type": "string"
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Prospects Remove Assignments

Bulk Action

Removes assignments from the prospects targeted by the query parameters (default: ALL) using the {userIds} array of strings passed in request body

SecuritybearerAuth

Request

query Parameters

object

Request Body schema: application/vnd.api+json

	object
type	string

Responses

200

422

JSON error message

post/batches/actions/prospectsRemoveAssignments

Request samples

application/vnd.api+json

{"data": {"attributes": {"ids": ["string"
],
"userIds": ["string"
]
}
},
"type": "string"
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Prospects Remove Tags

Bulk Action

Removes tags from the prospects targeted by the query parameters (default: ALL) using the {tags} array of strings passed in request body

SecuritybearerAuth

Request

query Parameters

object

Request Body schema: application/vnd.api+json

	object
type	string

Responses

200

422

JSON error message

post/batches/actions/prospectsRemoveTags

Request samples

application/vnd.api+json

{"data": {"attributes": {"ids": ["string"
],
"tags": ["string"
]
}
},
"type": "string"
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"action": "string",
"canceledAt": "2019-08-24T14:15:22Z",
"confirmCount": 0,
"confirmedAt": "2019-08-24T14:15:22Z",
"confirmedCountRequired": true,
"createdAt": "2019-08-24T14:15:22Z",
"externalStartPayload": "string",
"failures": 0,
"finishedAt": "2019-08-24T14:15:22Z",
"payload": { },
"pending": 0,
"startedAt": "2019-08-24T14:15:22Z",
"state": "string",
"summary": { },
"total": 0,
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batchItems": [{"links": {"related": "batchItem"
}
}
]
},
"type": "string"
}
}

Batch

Batch Relationships

Batch Resource Metadata

⌵ Batch Actions

Get a Collection of Batches

Create a New Batch

Request Body schema: application/vnd.api+jsonrequired

Get a Batch by ID

path Parameters

Update a Batch

path Parameters

Request Body schema: application/vnd.api+jsonrequired

Account Add Tags

Bulk Action

query Parameters

Request Body schema: application/vnd.api+json

Accounts Add Assignments

Bulk Action

query Parameters

Request Body schema: application/vnd.api+json

Accounts Assign Owner

Bulk Action

query Parameters

Request Body schema: application/vnd.api+json

Accounts Bulk Modify

Bulk Action

query Parameters

Request Body schema: application/vnd.api+json

Accounts Destroy All

Bulk Action

query Parameters

Request Body schema: application/vnd.api+json

Accounts Remove All Assignments

Bulk Action

query Parameters

Request Body schema: application/vnd.api+json

Accounts Remove Assignments

Bulk Action

query Parameters

Request Body schema: application/vnd.api+json

Accounts Remove Tags

Bulk Action

query Parameters

Request Body schema: application/vnd.api+json

Prospects Add Assignments

Bulk Action

query Parameters

Request Body schema: application/vnd.api+json

Prospects Add Tags

Bulk Action

query Parameters

Request Body schema: application/vnd.api+json

Prospects Add To Sequence

Bulk Action

query Parameters

Request Body schema: application/vnd.api+json

Prospects Assign Account

Bulk Action

query Parameters

Request Body schema: application/vnd.api+json

Prospects Assign Opportunity

Bulk Action

query Parameters

Request Body schema: application/vnd.api+json

Prospects Assign Owner

Bulk Action

query Parameters

Request Body schema: application/vnd.api+json

Prospects Bulk Modify

Bulk Action

query Parameters

Request Body schema: application/vnd.api+json

Prospects Destroy All

Bulk Action

query Parameters

Request Body schema: application/vnd.api+json

Prospects Finish All

Bulk Action

query Parameters

Request Body schema: application/vnd.api+json

Request Body schema: application/vnd.api+json
required

Request Body schema: application/vnd.api+json
required