Base Settings

This page describes how to set your project settings in the request data.

Each json request requires a base_settings. This determines several attributes for your project like project_name, tracking_id and company_template.

Base settings fields

Name

Type

Required

Description

project_name

String

true

If provided, will be used as PowerPoint file name when generating file.

tracking_id

String

false

This value will be used when sending and receiving data via webhook.

company_template

String

false

This value controls which template should be used for the Power point.

PPTX Builder will use in order of priority: template file provided on the request (pptx_file), company_template field in base settings, default.pptx

Example in JSON

{
    "base_settings": {
        "tracking_id": "0N1iCw5hdsBPrtxStETA123_-NzsWw2T0Bxao8oL3SI",
        "project_name": "test_demo",
        "company_template": "company_x.pptx"
    }
}

Last updated