Autofill Toll-Free Campaign Information | Pinnacle

Generate campaign details based off existing campaign and the brand it's connected to.

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Request

This endpoint expects an object.

additionalInfostringOptional

Any additional information you want to provide.

campaignIdstringOptional

Unique identifier for the campaign.

When autofilling 10DLC campaigns, it must begin with the prefix dlc_ (e.g., dlc_1234567890)
When autofilling Toll-Free campaigns, it must begin with the prefix tf_ (e.g., tf_1234567890)
When autofilling RCS campaigns, it must begin with the prefix rcs_ (e.g., rcs_1234567890)

Unique identifier for the campaign. - When autofilling 10DLC campaigns, it must begin with the prefix `dlc_` (e.g., `dlc_1234567890`) - When autofilling Toll-Free campaigns, it must begin with the prefix `tf_` (e.g., `tf_1234567890`) - When autofilling RCS campaigns, it must begin with the prefix `rcs_` (e.g., `rcs_1234567890`)

Response

Returns autofilled toll-free information.

brandstring or null

campaignIdstring or null

Unique identifier for the campaign. Must begin with the prefix tf_.

monthlyVolumeenum or null

Message volume.

namestring or null

Display name of the campaign.

optInobject or null

Opt-in keyword settings.

productionMessageContentstring or null

Explain message that would be sent.

useCaseobject or null

Use case classification for the campaign.

1	import { PinnacleClient } from "rcs-js";
2
3	async function main() {
4	const client = new PinnacleClient({
5	environment: "https://api.pinnacle.sh",
6	});
7	await client.campaigns.tollFree.autofill({
8	additionalInfo: "Please autofill missing campaign fields using my brand profile",
9	campaignId: "dlc_1234567890",
10	});
11	}
12	main();

1	{
2	"brand": "b_1234567890",
3	"campaignId": "tf_1234567890",
4	"monthlyVolume": "1,000",
5	"name": "Pinnacle",
6	"optIn": {
7	"method": "DIGITAL",
8	"url": "https://www.pinnacle.sh/",
9	"workflowDescription": "Visit https://www.pinnacle.sh/"
10	},
11	"productionMessageContent": "Join Pinnacle's workshop tomorrow and send your first RCS!",
12	"useCase": {
13	"summary": "Alerts clients about any Pinnacle hosted workshops.",
14	"value": "WORKSHOP_ALERTS"
15	}
16	}

Authentication

Request

Response

Errors