/persona-lists | Type: Application | PCID required: Yes
Tools
persona_lists_archive_a_browser_fingerprint_list_item
Archive a Browser Fingerprint List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
list-item-id | string | Yes | — | ID of list item to archive. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"list-item-id": {
"type": "string",
"description": "ID of list item to archive."
}
},
"required": [
"PCID",
"list-item-id"
]
}
persona_lists_archive_a_country_list_item
Archive a Country List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
list-item-id | string | Yes | — | ID of list item to archive. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"list-item-id": {
"type": "string",
"description": "ID of list item to archive."
}
},
"required": [
"PCID",
"list-item-id"
]
}
persona_lists_archive_a_device_fingerprint_list_item
Archive a Device Fingerprint List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
list-item-id | string | Yes | — | ID of list item to archive. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"list-item-id": {
"type": "string",
"description": "ID of list item to archive."
}
},
"required": [
"PCID",
"list-item-id"
]
}
persona_lists_archive_a_field_list_item
Archive a Field List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
list-item-id | string | Yes | — | ID of list item to archive. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"list-item-id": {
"type": "string",
"description": "ID of list item to archive."
}
},
"required": [
"PCID",
"list-item-id"
]
}
persona_lists_archive_a_geolocation_list_item
Archive a Geolocation List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
list-item-id | string | Yes | — | ID of list item to archive. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"list-item-id": {
"type": "string",
"description": "ID of list item to archive."
}
},
"required": [
"PCID",
"list-item-id"
]
}
persona_lists_archive_a_government_id_number_list_item
Archive a Government ID Number List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
list-item-id | string | Yes | — | ID of list item to archive. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"list-item-id": {
"type": "string",
"description": "ID of list item to archive."
}
},
"required": [
"PCID",
"list-item-id"
]
}
persona_lists_archive_a_list
Archive a List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
list-id | string | Yes | — | ID of the list to archive |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"list-id": {
"type": "string",
"description": "ID of the list to archive"
}
},
"required": [
"PCID",
"list-id"
]
}
persona_lists_archive_a_name_list_item
Archive a Name List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
list-item-id | string | Yes | — | ID of list item to archive. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"list-item-id": {
"type": "string",
"description": "ID of list item to archive."
}
},
"required": [
"PCID",
"list-item-id"
]
}
persona_lists_archive_a_phone_number_list_item
Archive a Phone Number List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
list-item-id | string | Yes | — | ID of list item to archive. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"list-item-id": {
"type": "string",
"description": "ID of list item to archive."
}
},
"required": [
"PCID",
"list-item-id"
]
}
persona_lists_archive_a_string_list_item
Archive a String List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
list-item-id | string | Yes | — | ID of list item to archive. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"list-item-id": {
"type": "string",
"description": "ID of list item to archive."
}
},
"required": [
"PCID",
"list-item-id"
]
}
persona_lists_archive_an_email_address_list_item
Archive an Email Address List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
list-item-id | string | Yes | — | ID of list item to archive. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"list-item-id": {
"type": "string",
"description": "ID of list item to archive."
}
},
"required": [
"PCID",
"list-item-id"
]
}
persona_lists_archive_an_ip_address_list_item
Archive an IP Address List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
list-item-id | string | Yes | — | ID of list item to archive. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"list-item-id": {
"type": "string",
"description": "ID of list item to archive."
}
},
"required": [
"PCID",
"list-item-id"
]
}
persona_lists_create_a_browser_fingerprint_list
Create a Browser Fingerprint List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
data | object | No | — | The data value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
}
},
"required": [
"PCID"
]
}
persona_lists_create_a_browser_fingerprint_list_item
Create a Browser Fingerprint List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
data | object | No | — | The data value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
}
},
"required": [
"PCID"
]
}
persona_lists_create_a_country_list
Create a Country List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
data | object | No | — | The data value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
}
},
"required": [
"PCID"
]
}
persona_lists_create_a_country_list_item
Create a Country List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
data | object | No | — | The data value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
}
},
"required": [
"PCID"
]
}
persona_lists_create_a_device_fingerprint_list_item
Create a Device Fingerprint List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
data | object | No | — | The data value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
}
},
"required": [
"PCID"
]
}
persona_lists_create_a_field_list_item
Create a Field List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
data | object | No | — | The data value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
}
},
"required": [
"PCID"
]
}
persona_lists_create_a_geolocation_list
Create a Geolocation List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
data | object | No | — | The data value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
}
},
"required": [
"PCID"
]
}
persona_lists_create_a_geolocation_list_item
Create a Geolocation List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
data | object | No | — | The data value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
}
},
"required": [
"PCID"
]
}
persona_lists_create_a_government_id_number_list
Create a Government ID Number List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
data | object | No | — | The data value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
}
},
"required": [
"PCID"
]
}
persona_lists_create_a_government_id_number_list_item
Create a Government ID Number List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
data | object | No | — | The data value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
}
},
"required": [
"PCID"
]
}
persona_lists_create_a_name_list
Create a Name List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
data | object | No | — | The data value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
}
},
"required": [
"PCID"
]
}
persona_lists_create_a_name_list_item
Create a Name List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
data | object | No | — | The data value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
}
},
"required": [
"PCID"
]
}
persona_lists_create_a_phone_number_list
Create a Phone Number List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
data | object | No | — | The data value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
}
},
"required": [
"PCID"
]
}
persona_lists_create_a_phone_number_list_item
Create a Phone Number List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
data | object | No | — | The data value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
}
},
"required": [
"PCID"
]
}
persona_lists_create_a_string_list_item
Create a String List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
data | object | No | — | The data value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
}
},
"required": [
"PCID"
]
}
persona_lists_create_a_strings_list
Create a Strings List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
data | object | No | — | The data value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
}
},
"required": [
"PCID"
]
}
persona_lists_create_an_email_address_list
Create an Email Address List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
data | object | No | — | The data value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
}
},
"required": [
"PCID"
]
}
persona_lists_create_an_email_address_list_item
Create an Email Address List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
data | object | No | — | The data value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
}
},
"required": [
"PCID"
]
}
persona_lists_create_an_ip_address_list
Create an IP Address List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
data | object | No | — | The data value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
}
},
"required": [
"PCID"
]
}
persona_lists_create_an_ip_address_list_item
Create an IP Address List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
data | object | No | — | The data value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
}
},
"required": [
"PCID"
]
}
persona_lists_list_all_lists
List all Lists Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
page | object | No | — | Page number for pagination |
fields | object | No | — | 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. |
filter | object | No | — | The filter value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"page": {
"type": "object",
"description": "Page number for pagination",
"properties": {
"after": {
"type": "string",
"description": "Object ID for pagination cursor"
},
"before": {
"type": "string",
"description": "Object ID for pagination cursor"
},
"size": {
"type": "number",
"description": "Limit on the number of objects returned"
}
}
},
"fields": {
"type": "object",
"description": "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."
},
"filter": {
"type": "object",
"description": "The filter value",
"properties": {
"status": {
"type": "string",
"description": "Filter lists by status",
"enum": [
"active",
"archived"
]
}
}
}
},
"required": [
"PCID"
]
}
persona_lists_retrieve_a_browser_fingerprint_list_item
Retrieve a Browser Fingerprint List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
list-item-id | string | Yes | — | ID of list item to retrieve. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"list-item-id": {
"type": "string",
"description": "ID of list item to retrieve."
}
},
"required": [
"PCID",
"list-item-id"
]
}
persona_lists_retrieve_a_country_list_item
Retrieve a Country List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
list-item-id | string | Yes | — | ID of list item to archive. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"list-item-id": {
"type": "string",
"description": "ID of list item to archive."
}
},
"required": [
"PCID",
"list-item-id"
]
}
persona_lists_retrieve_a_device_fingerprint_list_item
Retrieve a Device Fingerprint List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
list-item-id | string | Yes | — | ID of list item to retrieve. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"list-item-id": {
"type": "string",
"description": "ID of list item to retrieve."
}
},
"required": [
"PCID",
"list-item-id"
]
}
persona_lists_retrieve_a_field_list_item
Retrieve a Field List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
list-item-id | string | Yes | — | ID of list item to archive. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"list-item-id": {
"type": "string",
"description": "ID of list item to archive."
}
},
"required": [
"PCID",
"list-item-id"
]
}
persona_lists_retrieve_a_geolocation_list_item
Retrieve a Geolocation List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
list-item-id | string | Yes | — | ID of list item to archive. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"list-item-id": {
"type": "string",
"description": "ID of list item to archive."
}
},
"required": [
"PCID",
"list-item-id"
]
}
persona_lists_retrieve_a_government_id_number_list_item
Retrieve a Government ID Number List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
list-item-id | string | Yes | — | ID of list item to archive. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"list-item-id": {
"type": "string",
"description": "ID of list item to archive."
}
},
"required": [
"PCID",
"list-item-id"
]
}
persona_lists_retrieve_a_list
Retrieve a List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
list-id | string | Yes | — | ID of the list to retrieve |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"list-id": {
"type": "string",
"description": "ID of the list to retrieve"
}
},
"required": [
"PCID",
"list-id"
]
}
persona_lists_retrieve_a_name_list_item
Retrieve a Name List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
list-item-id | string | Yes | — | ID of list item to archive. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"list-item-id": {
"type": "string",
"description": "ID of list item to archive."
}
},
"required": [
"PCID",
"list-item-id"
]
}
persona_lists_retrieve_a_phone_number_list_item
Retrieve a Phone Number List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
list-item-id | string | Yes | — | ID of list item to archive. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"list-item-id": {
"type": "string",
"description": "ID of list item to archive."
}
},
"required": [
"PCID",
"list-item-id"
]
}
persona_lists_retrieve_a_string_list_item
Retrieve a String List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
list-item-id | string | Yes | — | ID of list item to archive. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"list-item-id": {
"type": "string",
"description": "ID of list item to archive."
}
},
"required": [
"PCID",
"list-item-id"
]
}
persona_lists_retrieve_an_email_address_list_item
Retrieve an Email Address List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
list-item-id | string | Yes | — | ID of list item to archive. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"list-item-id": {
"type": "string",
"description": "ID of list item to archive."
}
},
"required": [
"PCID",
"list-item-id"
]
}
persona_lists_retrieve_an_ip_address_list_item
Retrieve an IP Address List Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Key-Inflection | string | No | — | Determines casing for the API response. |
Idempotency-Key | string | No | — | Ensures the request is idempotent. |
Persona-Version | string | No | — | Server API version. More info on versioning can be found here. |
include | string | No | — | 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. |
fields | object | No | — | 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. |
list-item-id | string | Yes | — | ID of list item to archive. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"list-item-id": {
"type": "string",
"description": "ID of list item to archive."
}
},
"required": [
"PCID",
"list-item-id"
]
}