Create NPI List With Attributes

An NPI list with attributes is an NPI list that appends a client's metadata to their list of NPIs. This endpoint allows a user to create an NPI list with attributes.

Endpoint

Method: POST

/v2/npi/npi-list/account/{accountId}/attributes

Path Parameter: the account ID you want to associate with the list you are creating.

Field List

Name	Data Type	Required	Notes
attributeValues	Array of Array of Strings	No	Needs to have the same number of fields in each record that correspond to the attribute list
attributes	Array of Strings	No	Null values or empty strings are accepted
name	String	Yes
npiColumnIndex	Numeric	Yes	First attribute = 0. Mark where your NPI is in your list of attributes. This will be used for validation in the call.
applications	String - ENUM	Yes	[“LIFE”], [“SIGNAL”] or [‘SOCIAL”]
advertisers	Array of Strings	Yes	You can make the list available to multiple advertisers

Sample Request

{
  "attributeValues": [
    ["1639137706", "yes", "NPI Targeted Banners", "PulsePoint Inc.", "123456"]
  ],
  "attributes": ["NPI_ID", "Active", "CampaignName", "CompanyName", "CustomID"],
  "name": "NPI_with_Attr",
  "npiColumnIndex": 0,
  "applications": ["LIFE"],
  "advertisers": ["Demo"]
}

Sample Response

{
    "attributes": [
        "NPI_ID",
        "Active",
        "CampaignName",
        "CompanyName",
        "CustomID"
    ],
    "attributeValues": [
        [
            "1639137706",
            "yes",
            "NPI Targeted Banners",
            "PulsePoint Inc.",
            "123456"
        ]
    ],
    "npiColumnIndex": 0,
    "name": "NPI_with_Attr",
    "npiGroupId": 70448,
    "applications": [
        "LIFE"
    ],
    "advertisers": [
        "Demo"
    ]
}

Validation/Errors

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