Skip to main content

Get Batch Task Error Details

This request returns error details data for a batch task, targeted by secure ID.

get /batch/tasks/{task_sid}/errors

Sample​

A sample GET request to get error details data for a batch task, targeted by secure ID:

curl -X GET \
'https://qa-api.carrierx.com/core/v2/batch/tasks/2ab7081f-db4a-42b3-b7ed-74e1019f30a6/errors?offset=0&limit=1000' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response​

200 status code with a list of Error Detail objects:

{
    "items": [
        {
            "error": {
                "message": "object validation error",
                "errors": [
                    {
                    "field": "phonenumber",
                    "message": "this phonenumber already exists",
                    "reference_sid": "940f3315-9ae7-4a1a-a66c-2df33933e10c"
                    }
                ]
            },
            "key": "{\"phonenumber\":19796101570}"
        }
    ]
}

This request is enabled for Pagination.

Required Scopes​

To get information about a Task object, the partner must have one of the following scopes enabled:

  • batch.manage
  • batch.read