Create NPI List
This endpoint allows clients to create a new NPI list to be used in your campaigns for targeting. The API user must have access to the advertiser and account you are attaching the list to.
Endpoint
Method: POST
/v2/npi/npi-list/account/accountId**Path Parameter: **The account that the new NPI list should be associated with
Fields
| Field Name | Data Type | Required | Notes |
|---|---|---|---|
| name | String | Yes | |
| npis | Array of Strings | Yes | list must have <100k elements, NPIs must not exceed 10 characters |
| advertisers | Array of Strings | Yes | must be valid advertiser names in Life |
| applications | Enum | Yes | [“LIFE”], [“SIGNAL”] or [‘SOCIAL”] |
Sample Request
{
"name": "Endocrinologist_2022_1",
"npis": ["3137933127", "3134730121"],
"advertisers": ["Demo"],
"applications": ["LIFE"]
}Response
Here is a response to a successful call:
{
"id": 70435,
"npis": [
"3137933127", "3134730121"
],
"advertisers": [
"Demo"
],
"applications": [
"LIFE"
],
"name": "Endocrinologist_2022_1",
Validations/Error Messages
| Code | Description |
|---|---|
| 400 | Invalid property name for post operation |
| 400 | Invalid values for field "applications" |
| 400 | npis is a required field |
| 400 | Invalid NPI number |
| 400 | NPI ID cannot exceed 10 characters |
| 400 | advertisers is a required field |
| 400 | >1M npis |
Updated 4 months ago
