Campaign Payload

Generate campaign payload using the DIY tool on the business console or follow the documentation.

Template Generator is a DIY tool within the Truecaller for Business console that allows marketers to craft their marketing templates and generate a JSON payload for seamless integration with your external systems.

Navigate to the "Verified Campaigns" section within your business console and click on "Template Generator" option

Step 1: Campaign identifiers and use case

• Campaign Name: Enter the name of your campaign.

• Campaign ID: Enter your campaign's unique identifier, this could be the same external campaign reference or campaign ID that you use in your external system

• Campaign Type: Select the relevant type (Lifecycle or Offer).

Step 2: Choose your Display Unit

• Select the display unit(s) where your campaign will run:

  • Caller ID: The incoming pop-up shown when a call is incoming on a user device.

  • Post Call Pop-up (Universal): The pop-up displayed after a call is answered., missed or rejected.

  • Missed Call Pop-up : The pop-up shown after a missed call.

  • Sticky Message ID: The UI shown for transactional message notifications

  • Business Profile : The brand page on the Truecaller app/

• Each display unit may have different template style options available.

Step 3: Configure Campaign template

• Dynamic Fields : For each selected Display Unit and Template Style the parameters of customization are different.

  • Custom Fields: Enter the campaign message content (title, subtitle, CTA, deeplink, etc.) based on the chosen display unit and template style chosen.

• Static Fields : These are stored and saved in our backend mapped to your Campaign ID

  • Text Color: Choose a text color that works best with your brand image (Black or White).

  • Template Theme: Select a brand color for the template theme.

  • Brand Image: Host your marketing assets on Truecaller Assets page (Note : Adhere to recommended dimensions and image storage requirements).

• Save and Generate JSON: Click this button when you're satisfied with your template.

Step 4: JSON Generator

• JSON Payload: A formatted JSON payload, based on your template and selections, will be displayed. This payload adheres to the required format for Truecaller's Verified Campaigns Webhook endpoint.

• Copy: Click the "Copy" button to copy the JSON payload to your clipboard.

Important Notes:

• Template Styles: Each display unit may offer different template styles (Plain Text with CTA, Image with CTA, Personalized Content with CTA - image on left/right). Experiment to find the best fit for your campaign.

• Image Dimensions: Be sure to follow Truecaller's recommended image dimensions for optimal display and outcomes.

• Third-Party Integration: Refer to your external system's documentation to understand how to integrate the generated JSON payload correctly.