# Validate Toll-Free Campaign Information

`POST /campaigns/toll-free/validate`

Validate your toll-free campaign configuration against carrier requirements and compliance rules.

## Authentication

Send your API key in the `PINNACLE-API-KEY` header.

## Request body

Required.

Content type: `application/json`.

### Fields

- `additionalInfo` — `string`, optional. Any additional information you want to provide.
- `campaignId` — `string`. Unique identifier for the campaign.
- When validating 10DLC campaigns, it must begin with the prefix `dlc_` (e.g., `dlc_1234567890`)
- When validating toll-free campaigns, it must begin with the prefix `tf_` (e.g., `tf_1234567890`)
- When validating RCS campaigns, it must begin with the prefix `rcs_` (e.g., `rcs_1234567890`)

### Example

```json
{
  "additionalInfo": "Please validate this DLC campaign for 10DLC compliance",
  "campaignId": "dlc_1234567890"
}
```

## Responses

### 200

Returns validation results.

Content type: `application/json`. Schema: `CampaignValidationResult`.

- `errors` — `object[]`. List of validation errors.
- `errors[].description` — `string`. A human-readable description of the error.
- `errors[].example` — `string`, optional. An example of a valid value for the field.
- `errors[].field` — `string`. The field that is not valid.
- `is_valid` — `boolean`. Whether the campaign is valid or not.

Example:

```json
{
  "is_valid": true,
  "errors": []
}
```

### 400

Validation failed. The payload has missing required fields and/or invalid types.

See https://zod.dev/error-formatting for more information.

Content type: `application/json`. Schema: `object`.

- `description` — `string`. Human-readable summary of validation failures.
- `errors` — `object`. Structured dictionary of issues containing two main sections:
- `errors`: Array of global validation errors not tied to specific fields
- `properties`: Object mapping field names to their specific validation errors, where each field contains an `errors` array

Example:

```json
{
  "description": "✖ Invalid input: expected string, received number\n  → at example_field",
  "errors": {
    "errors": [
      "Unrecognized key: 'extraKey'"
    ],
    "properties": {
      "example_field": {
        "errors": [
          "Invalid input: expected string, received NaN"
        ]
      }
    }
  }
}
```

### 401

The request lacks valid authentication credentials or the provided credentials are invalid.

Ensure you're including a valid API key in the request headers and that your account has the necessary permissions to access this endpoint.

Content type: `application/json`. Schema: `object`.

- `error` — `string`. Human-readable description of the error that occurred, corresponding to the HTTP status code.

Example:

```json
{
  "error": "Invalid API key."
}
```

### 403

Your subscription does not include access to this feature.

This occurs when attempting to use functionality that requires a higher subscription tier.
Please upgrade your subscription to access this feature.

Content type: `application/json`. Schema: `object`.

- `error` — `string`. Human-readable description of the error that occurred, corresponding to the HTTP status code.

Example:

```json
{
  "error": "Your subscription does not include access to this feature."
}
```

### 500

An unexpected error occurred on Pinnacle's servers while processing your request.

If this error persists, please contact support with the request details.

Content type: `application/json`. Schema: `object`.

- `error` — `string`. Human-readable description of the error that occurred, corresponding to the HTTP status code.

Example:

```json
{
  "error": "An unexpected error occurred while processing your request."
}
```

## SDK examples

### TypeScript

```typescript
import { PinnacleClient } from "rcs-js";

const client = new PinnacleClient({
  apiKey: process.env.PINNACLE_API_KEY!,
});

await client.campaigns.tollFree.validate({
    additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
    campaignId: "dlc_1234567890"
});
```

### Python

```python
import os
from rcs import Pinnacle

client = Pinnacle(
    api_key=os.environ["PINNACLE_API_KEY"],
)

client.campaigns.toll_free.validate(
    additional_info="Please validate this DLC campaign for 10DLC compliance",
    campaign_id="dlc_1234567890",
)
```

### Ruby

```ruby
require "rcs"

client = Pinnacle::Client.new(
  api_key: ENV.fetch("PINNACLE_API_KEY")
)

client.campaigns.toll_free.validate(
  additional_info: "Please validate this DLC campaign for 10DLC compliance",
  campaign_id: "dlc_1234567890"
)
```

## Machine-readable schema

[OpenAPI 3.1 JSON](https://docs.pinnacle.sh/openapi.json)