Create a Batch Job
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.
Request
- Base URL: https://api.withpersona.com/api/v1
- URL: https://api.withpersona.com/api/v1/batch-jobs
- Auth: HTTP bearer
Query parameters
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.
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.
Headers
Determines casing for the API response.
Ensures the request is idempotent.
Server API version. More info on versioning can be found here.
Request body
Response
The Batch Job has been created and processing has started.
Changes
No recorded changes to this operation across all 1 revision of this API.