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"
}
Array of links (object) (batchItem) The batch items associated with this batch. |
{- "batchItems": [
- {
- "links": {
- "related": "batchItem"
}
}
]
}
METADATA NAME | DESCRIPTION | QUERY PARAM |
---|---|---|
canWrite | A boolean value indicating whether the current API user has write access to this resource. | provideAuthorizationMeta |
{- "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"
}
]
}
object |
Created
JSON error message
{- "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"
}
}
{- "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"
}
}
{- "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"
}
}
{- "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"
}
}
{- "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"
}
}
Adds tags to the accounts targeted by the query parameters (default: ALL) using the {tags} array of strings passed in request body
OK
JSON error message
{- "data": {
- "attributes": {
- "tags": [
- "string"
]
}
}, - "type": "string"
}
{- "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"
}
}
Adds assignments to the accounts targeted by the query parameters (default: ALL) using the {userIds} array of strings passed in request body
OK
JSON error message
{- "data": {
- "attributes": {
- "userIds": [
- "string"
]
}
}, - "type": "string"
}
{- "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"
}
}
assign an user with {ownerId} as owner to all the targeted accounts
OK
JSON error message
{- "data": {
- "attributes": {
- "ownerId": 0
}
}, - "type": "string"
}
{- "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"
}
}
Modifies the accounts targeted by the query parameters (default: ALL) using the {field, value} pair passed in request body
OK
JSON error message
{- "data": {
- "attributes": {
- "fieldName": "string",
- "fieldValue": "string"
}
}, - "type": "string"
}
{- "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"
}
}
Deletes the accounts targeted by the query parameters (default: ALL)
object |
OK
JSON error message
{- "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"
}
}
Removes all assignments from the accounts targeted by the query parameters (default: ALL)
object |
OK
JSON error message
{- "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"
}
}
Removes assignments from the accounts targeted by the query parameters (default: ALL) using the {userIds} array of strings passed in request body
OK
JSON error message
{- "data": {
- "attributes": {
- "userIds": [
- "string"
]
}
}, - "type": "string"
}
{- "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"
}
}
Removes tags from the accounts targeted by the query parameters (default: ALL) using the {tags} array of strings passed in request body
OK
JSON error message
{- "data": {
- "attributes": {
- "tags": [
- "string"
]
}
}, - "type": "string"
}
{- "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"
}
}
Adds assignments to the prospects targeted by the query parameters (default: ALL) using the {userIds} array of strings passed in request body
OK
JSON error message
{- "data": {
- "attributes": {
- "userIds": [
- "string"
]
}
}, - "type": "string"
}
{- "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"
}
}
Adds tags to the prospects targeted by the query parameters (default: ALL) using the {tags} array of strings passed in request body
OK
JSON error message
{- "data": {
- "attributes": {
- "tags": [
- "string"
]
}
}, - "type": "string"
}
{- "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"
}
}
Add Prospects To Sequence
OK
JSON error message
{- "data": {
- "attributes": {
- "mailboxId": 0,
- "sequenceId": 0
}
}, - "type": "string"
}
{- "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"
}
}
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
OK
JSON error message
{- "data": {
- "attributes": {
- "accountId": "string"
}
}, - "type": "string"
}
{- "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"
}
}
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
OK
JSON error message
{- "data": {
- "attributes": {
- "opportunityId": "string"
}
}, - "type": "string"
}
{- "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"
}
}
assign an user with {ownerId} as owner to all the targeted prospects
OK
JSON error message
{- "data": {
- "attributes": {
- "ownerId": 0
}
}, - "type": "string"
}
{- "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"
}
}
Modifies the prospects targeted by the query parameters (default: ALL) using the {field, value} pair passed in request body
OK
JSON error message
{- "data": {
- "attributes": {
- "fieldName": "string",
- "fieldValue": "string"
}
}, - "type": "string"
}
{- "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"
}
}
Deletes the prospects targeted by the query parameters (default: ALL)
object |
OK
JSON error message
{- "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"
}
}
For all prospects targeted by the query parameters (default: ALL), attempt to finish the associated prospect sequence
object |
OK
JSON error message
{- "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"
}
}
For all prospects targeted by the query parameters (default: ALL), attempt to pause the associated prospect sequence
object |
OK
JSON error message
{- "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"
}
}
Removes all assignments from the prospects targeted by the query parameters (default: ALL)
object |
OK
JSON error message
{- "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"
}
}
Removes assignments from the prospects targeted by the query parameters (default: ALL) using the {userIds} array of strings passed in request body
OK
JSON error message
{- "data": {
- "attributes": {
- "userIds": [
- "string"
]
}
}, - "type": "string"
}
{- "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"
}
}
Removes tags from the prospects targeted by the query parameters (default: ALL) using the {tags} array of strings passed in request body
OK
JSON error message
{- "data": {
- "attributes": {
- "tags": [
- "string"
]
}
}, - "type": "string"
}
{- "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"
}
}