Validate Toll-Free Campaign Information | Pinnacle

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

PINNACLE-API-KEYstring

API Key authentication via header

This endpoint expects an object.

campaignIdstringRequired

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)

additionalInfostringOptional

Any additional information you want to provide.

Returns validation results.

errorslist of objects

List of validation errors.

is_validboolean

Whether the campaign is valid or not.

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

1	import { PinnacleClient } from "rcs-js";
2
3	async function main() {
4	const client = new PinnacleClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.campaigns.tollFree.validate({
8	campaignId: "dlc_1234567890",
9	additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
10	});
11	}
12	main();