> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Versium: Online Audience Append

> Append online-audience identifiers. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Append online-audience identifiers.

<Info>
  Tool ID: `versium_online_audience_append`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'versium_online_audience_append',
  {
    "first": "example",
    "last": "example",
    "email": "jane.doe@example.com"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={null}
deepline tools execute versium_online_audience_append --input '{
  "first": "example",
  "last": "example",
  "email": "jane.doe@example.com"
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "versium": {
      "version": "example",
      "num_matches": 123,
      "num_results": 123,
      "query_id": "query_123",
      "query_time": 123,
      "results": [
        {}
      ],
      "input_query": {}
    }
  }
}
```

Use `deepline tools get versium_online_audience_append --json` for the latest machine-readable contract.

## Input reference

Return platform-ready online audience identifiers for a consumer or business person.

| Name                       | Type      | Required | Default | Details                                                                   |
| -------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------- |
| `payload.first`            | `string`  | No       | —       | A person's first name                                                     |
| `payload.last`             | `string`  | No       | —       | A person's last name                                                      |
| `payload.fullname`         | `string`  | No       | —       | A person First and Last name (i.e. John Smith)                            |
| `payload.address`          | `string`  | No       | —       | A house/building number and street                                        |
| `payload.address_2`        | `string`  | No       | —       | The unit number of an address (i.e. Unit 2)                               |
| `payload.city`             | `string`  | No       | —       | A city name                                                               |
| `payload.state`            | `string`  | No       | —       | A US State two letter abbreviation                                        |
| `payload.zip`              | `string`  | No       | —       | A 5 digit US ZIP Code                                                     |
| `payload.country`          | `string`  | No       | —       | A 2 letter country abbreviation                                           |
| `payload.phone`            | `string`  | No       | —       | A valid 10 digit North American phone number                              |
| `payload.domain`           | `string`  | No       | —       | A business domain                                                         |
| `payload.business`         | `string`  | No       | —       | A business name                                                           |
| `payload.li_url`           | `string`  | No       | —       | A valid LinedIn URL                                                       |
| `payload.email`            | `string`  | No       | —       | A valid consumer or business email address                                |
| `payload.cfg_maxrecs`      | `integer` | No       | `1`     | Number of records to return, from 1 through 100 Minimum: 1. Maximum: 100. |
| `payload.rcfg_max_time`    | `number`  | No       | —       | Maximum allowed API runtime in seconds Minimum: 0.                        |
| `payload.rcfg_oa_services` | `array`   | No       | —       | Online audience services to return; defaults to all services              |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Return platform-ready online audience identifiers for a consumer or business person.",
    "properties": {
      "first": {
        "type": "string",
        "description": "A person's first name"
      },
      "last": {
        "type": "string",
        "description": "A person's last name"
      },
      "fullname": {
        "type": "string",
        "description": "A person First and Last name (i.e. John Smith)"
      },
      "address": {
        "type": "string",
        "description": "A house/building number and street"
      },
      "address_2": {
        "type": "string",
        "description": "The unit number of an address (i.e. Unit 2)"
      },
      "city": {
        "type": "string",
        "description": "A city name"
      },
      "state": {
        "type": "string",
        "description": "A US State two letter abbreviation"
      },
      "zip": {
        "type": "string",
        "description": "A 5 digit US ZIP Code"
      },
      "country": {
        "type": "string",
        "description": "A 2 letter country abbreviation"
      },
      "phone": {
        "type": "string",
        "description": "A valid 10 digit North American phone number"
      },
      "domain": {
        "type": "string",
        "description": "A business domain"
      },
      "business": {
        "type": "string",
        "description": "A business name"
      },
      "li_url": {
        "type": "string",
        "description": "A valid LinedIn URL"
      },
      "email": {
        "type": "string",
        "description": "A valid consumer or business email address"
      },
      "cfg_maxrecs": {
        "type": "integer",
        "description": "Number of records to return, from 1 through 100",
        "default": 1,
        "minimum": 1,
        "maximum": 100
      },
      "rcfg_max_time": {
        "type": "number",
        "description": "Maximum allowed API runtime in seconds",
        "minimum": 0
      },
      "rcfg_oa_services": {
        "type": "array",
        "description": "Online audience services to return; defaults to all services",
        "items": {
          "type": "string",
          "enum": [
            "facebook",
            "google",
            "linkedin",
            "generic",
            "adroll",
            "original",
            "liveramp",
            "stackadapt"
          ]
        }
      }
    },
    "required": [],
    "anyOf": [
      {
        "required": [
          "first",
          "last",
          "email"
        ]
      },
      {
        "required": [
          "business",
          "first",
          "last",
          "city",
          "state"
        ]
      },
      {
        "required": [
          "domain",
          "first",
          "last",
          "city",
          "state"
        ]
      },
      {
        "required": [
          "fullname",
          "email"
        ]
      },
      {
        "required": [
          "business",
          "fullname",
          "city",
          "state"
        ]
      },
      {
        "required": [
          "domain",
          "fullname",
          "city",
          "state"
        ]
      },
      {
        "required": [
          "li_url"
        ]
      },
      {
        "required": [
          "email"
        ]
      },
      {
        "required": [
          "phone"
        ]
      },
      {
        "required": [
          "address",
          "city",
          "state",
          "zip"
        ]
      },
      {
        "required": [
          "first",
          "last",
          "city",
          "state"
        ]
      },
      {
        "required": [
          "first",
          "last",
          "zip"
        ]
      }
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name                               | Type      | Required | Default | Details                                        |
| ---------------------------------- | --------- | -------- | ------- | ---------------------------------------------- |
| `result.data`                      | `object`  | Yes      | —       | Raw Versium REACH response.                    |
| `result.data.versium`              | `object`  | Yes      | —       | —                                              |
| `result.data.versium.version`      | `string`  | Yes      | —       | —                                              |
| `result.data.versium.match_counts` | `record`  | No       | —       | —                                              |
| `result.data.versium.num_matches`  | `integer` | Yes      | —       | Minimum: 0.                                    |
| `result.data.versium.num_results`  | `integer` | Yes      | —       | Minimum: 0.                                    |
| `result.data.versium.query_id`     | `string`  | Yes      | —       | —                                              |
| `result.data.versium.query_time`   | `number`  | Yes      | —       | Minimum: 0.                                    |
| `result.data.versium.results`      | `array`   | Yes      | —       | —                                              |
| `result.data.versium.input_query`  | `record`  | Yes      | —       | —                                              |
| `result.meta`                      | `object`  | No       | —       | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Raw Versium REACH response.",
        "properties": {
          "versium": {
            "type": "object",
            "properties": {
              "version": {
                "type": "string"
              },
              "match_counts": {
                "type": "object",
                "additionalProperties": {
                  "type": "integer",
                  "minimum": 0
                }
              },
              "num_matches": {
                "type": "integer",
                "minimum": 0
              },
              "num_results": {
                "type": "integer",
                "minimum": 0
              },
              "query_id": {
                "type": "string"
              },
              "query_time": {
                "type": "number",
                "minimum": 0
              },
              "results": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": true
                }
              },
              "input_query": {
                "type": "object",
                "additionalProperties": true
              }
            },
            "required": [
              "version",
              "num_matches",
              "num_results",
              "query_id",
              "query_time",
              "results",
              "input_query"
            ],
            "additionalProperties": true
          }
        },
        "required": [
          "versium"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `per_result` (per result).
* Estimated Deepline credits: `0.7` per pricing unit.

## Related documentation

* [Versium provider guide](/docs/providers/versium/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)