Gets the current status of an asynchronous operation on a list. The `status` property can have one of the following values: `pending`, `running`, `completed`, or `failed`. If the status is `failed`, the `error` property will contain a message describing the error.
/accounts/{account_identifier}/rules/lists/bulk_operations/{operation_id}
get
Lists
lists-get-bulk-operation-status
{
"business": true,
"enterprise": true,
"free": true,
"pro": true
}null[
{
"in": "path",
"name": "operation_id",
"required": true,
"schema": {
"description": "The unique operation ID of the asynchronous action.",
"example": "4da8780eeb215e6cb7f48dd981c4ea02",
"readOnly": true,
"type": "string"
}
},
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"completed": {
"description": "The RFC 3339 timestamp of when the operation was completed.",
"example": "2020-01-01T08:00:00Z",
"readOnly": true,
"type": "string"
},
"error": {
"description": "A message describing the error when the status is `failed`.",
"example": "This list is at the maximum number of items",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The unique operation ID of the asynchronous action.",
"example": "4da8780eeb215e6cb7f48dd981c4ea02",
"readOnly": true,
"type": "string"
},
"status": {
"description": "The current status of the asynchronous operation.",
"enum": [
"pending",
"running",
"completed",
"failed"
],
"example": "failed",
"readOnly": true,
"type": "string"
}
},
"required": [
"id",
"status"
],
"type": "object"
}
},
"type": "object"
}
]
}
}
},
"description": "Get bulk operation status response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"completed": {
"description": "The RFC 3339 timestamp of when the operation was completed.",
"example": "2020-01-01T08:00:00Z",
"readOnly": true,
"type": "string"
},
"error": {
"description": "A message describing the error when the status is `failed`.",
"example": "This list is at the maximum number of items",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The unique operation ID of the asynchronous action.",
"example": "4da8780eeb215e6cb7f48dd981c4ea02",
"readOnly": true,
"type": "string"
},
"status": {
"description": "The current status of the asynchronous operation.",
"enum": [
"pending",
"running",
"completed",
"failed"
],
"example": "failed",
"readOnly": true,
"type": "string"
}
},
"required": [
"id",
"status"
],
"type": "object"
}
},
"type": "object"
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "Get bulk operation status response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]