Customization Templates

Customization templates are ways for you to configure the design and text of Truv Bridge and your workflow.


Find Truv Templates within the Customization section of your Dashboard. Configure Truv Bridge and your order flow for your specific product types when creating a customization template. For example, you can apply different branding and language according to your specific client needs.

Your template configurations take priority over other settings, such universal branding or those from Truv Bridge and Order.

Customization Template Attributes

View the payload for retrieving customizable template information.

AttributeTypeDescription
idstringUnique identifier of the template
namestringTemplate name
productsarrayList of products with applied customizable templates
default_for_productsbooleanStatus of customizable template as product default
bridgeobjectConfiguration object for Truv Bridge template
brandingobjectConfiguration object for branding template
ordersobjectConfiguration object for Orders template
created_atdatetimeTimestamp for created customizable template
updated_atdatetimeTimestamp for updated customizable template

Endpoints

The table below covers the available endpoints for customizable templates.

Endpoint
List all customizable templates - GET /templates/
Create a customizable template - POST /templates/
Retrieve a customizable template - GET /templates/{template_id}/
Update a customizable template - PATCH /templates/{template_id}/
Delete a customizable template - DELETE /templates/{template_id}/

Sample Object

View the JSON response example below.

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "My template",
  "products": [],
  "default_for_products": false,
  "bridge": {
    "texts": {
      "search_header": "string",
      "success_cta": "string"
    },
    "hide_truv_logo": false,
    "hide_support_button": false
  },
  "branding": {
    "company_name": "string",
    "accent_color": "#aabb00",
    "background_color": "rgba(0, 0, 255, 0.5)",
    "hide_confetti": false,
    "custom_end_user_agreement": {
      "header": "string",
      "url": "string"
    }
  },
  "orders": {
    "link_expiration": "24",
    "custom_field_title": "string",
    "support_email": "[email protected]",
    "first_sms": {
      "text": "string",
      "apply_for_reminder": false
    },
    "reminder_sms": {
      "text": "string"
    },
    "first_email": {
      "subject": "string",
      "header": "string",
      "button": "string",
      "caption": "string",
      "apply_for_reminder": false
    },
    "reminder_email": {
      "subject": "string",
      "header": "string",
      "button": "string",
      "caption": "string"
    },
    "landing": {
      "header": "string",
      "body": "string",
      "hide_faq": false,
      "success_screen": {
        "header": "string",
        "body": "string"
      },
      "expired_screen": {
        "header": "string",
        "body": "string"
      }
    }
  },
  "created_at": "2022-05-04T11:30:00Z",
  "updated_at": "2022-05-04T12:00:00Z"
}