This API utilizes the REACH Job processing queue to generate a B2B Persona csv file, which can be downloaded after creation.
By submitting the API request, you agree to be charged based on the results from the generated list.
Format
API End point: https://api.versium.com/v2/jobs?operation=personaListGen
HTTP method: POST
This API uses the Configuration Parameters
Required Configuration Parameters
| Name | Description | Value Type | Notes |
|---|---|---|---|
| name | What to name the list | string | |
| project_name | The name of the project to store the list in. If a project with this name doesn’t exist, a new one will be created. | string | Required if project_id is not provided |
| project_id | The id of an existing project to store the list in. | integer | Required if project_name is not provided |
| callback_url | A URL to ping when the job has completed or failed. | string |
For additional required and optional configuration parameters, see the Configuration Parameters page.
Optional Configuration Parameters
| Name | Description | Value Type |
|---|---|---|
| callback_url | A URL to ping when the job has completed or failed. | string |
Example:
Generate a list with the following configuration and filters:
- name: redmond_wa
- in project name: 1116
- with output b2b_persona_online_audience
- in the geographical area of city state: Redmond, WA
https://api.versium.com/v2/jobs?operation=personaListGen&name=redmond_wa&project_name=1116&output[]=b2b_persona_online_audience&d_city_state[]=Redmond, wa
The JSON response will contain meta information and the state_url that can be used to obtain the job status. Once completed the JSON response will include the URL to send subsequent API requests to.
Dispatched response
{
"versium": {
"version": "2.0",
"query_id": "fd4cb1d842372ee65c10d56bfe59e051",
"query_time": 0.1813650131225586,
"results": {
"id": 810271,
"guid": "d49747d6-3953-4c35-9d9f-e413f33f2224",
"state": "dispatched",
"operation": "personaListGen",
"created_at": "2024-05-24T20:52:11.000000Z",
"finished_at": null,
"config": {
"cfg_groupby": "emailAddr",
"d_city_state": [
"Redmond, wa"
],
"listgen_output_option": [
"oa"
]
},
"output_list": {
"id": 636865,
"download_url": null,
"num_matches": 0,
"num_records": 0,
"project_id": 80370,
"insights": null
},
"state_url": "https://api.versium.com/v2/jobs/810271",
"callback_url": null,
"suppression_input_list_ids": null,
"est_sec_remaining": null,
"progress_percentage": 0
}
}
}