Create a Batch Job

POST

https://api.withpersona.com/api/v1/batch-jobs

POST

/api/v1/batch-jobs

curl -X POST https://api.withpersona.com/api/v1/batch-jobs \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "data": {
    "attributes": {
      "operation": "update",
      "object": "account",
      "lookup-field": "reference_id",
      "rows": [
        {
          "name_first": "Jane",
          "name_last": "Doe",
          "reference_id": "a-123"
        },
        {
          "name_first": "John",
          "name_last": "Smith",
          "reference_id": "a-456"
        }
      ],
      "account-type-id": "acttp_ABC123"
    }
  }
}'

{
  "data": {
    "type": "batch-job",
    "id": "mprtpr_ABC123DEF456",
    "attributes": {
      "status": "pending",
      "run-count": 1,
      "started-at": null,
      "ended-at": null,
      "created-at": "2024-01-15T09:59:45.000Z",
      "updated-at": "2024-01-15T09:59:45.000Z",
      "redacted-at": null,
      "run-data": {
        "column-names": [
          "reference_id",
          "name_first",
          "name_last"
        ],
        "error-count": 0,
        "rows-read": 0,
        "row-count": 2,
        "success-count": 0,
        "created-count": 0,
        "updated-count": 0
      }
    }
  }
}

object: account supports operation: update (lookup by token or reference_id) or operation: upsert (lookup by reference_id only, and requires account_type_id on the pipeline or on each row).
object: inquiry only supports operation: update with lookup_field: token.

Submits a batch of rows to update or upsert Accounts, or update Inquiries, in bulk. Persona processes the rows asynchronously as a Batch Job; poll the returned job or retrieve its errors to check progress. - **`object: account`** supports `operation: update` (lookup by `token` or `reference_id`) or `operation: upsert` (lookup by `reference_id` only, and requires `account_type_id` on the pipeline or on each row). - **`object: inquiry`** only supports `operation: update` with `lookup_field: token`.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

includestringOptional

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details.

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details.

fieldsmap from strings to stringsOptional

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details.

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details.

Request

This endpoint expects an object.

dataobjectRequired

Response headers

RateLimit-Limitinteger

The maximum number of requests permitted in the current rate limit window for the API key used to authenticate the request. Returned on every authenticated response.

RateLimit-Remaininginteger

The number of requests remaining in the current rate limit window for the API key used to authenticate the request. Returned on every authenticated response.

RateLimit-Resetinteger

The number of seconds until the current rate limit window resets. Returned on every authenticated response.

Request-IdstringOptional

The unique identifier of the API log entry that recorded this request. Starts with req_. Include this value when reaching out to Persona support. Present on every authenticated response, including error responses.

Persona-Environment-IdstringOptional

The token of the Persona environment that handled the request. Returned on every authenticated response, including most error responses.

Persona-Organization-IdstringOptional

The token of the Persona organization that handled the request. Returned on every authenticated response, including most error responses.

Response

The Batch Job has been created and processing has started.

dataobject

A Batch Job object.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error