v1

latestOpenAPI 3.1.0© Copyright Partoo2026-07-26163503484.0 KB
Feedback Management

Create an email template

<Warning> The Feedback Management API is currently in **BETA**, therefore the following endpoints are subject to modification, given a **2 week notice**.

If you are planning to use any of them, please notify us so we will be able to keep you informed about upcoming changes. </Warning>

Creates a new feedback email template for the authenticated user's organization.

When cta_type is BUTTON, the cta_text field is required.

post/feedback/email-templates

Request body

namestring

Internal name for the template

subjectstring

Email subject line

titlestring

Title displayed in the email body

bodystring

Main body text of the email

cta_textstring nullable

Call-to-action label. Required when cta_type is BUTTON.

cta_type'BUTTON' | 'EMBEDDED_NPS'

Type of call-to-action rendered in the email.

  • BUTTON: a clickable button; cta_text must be non-null.
  • EMBEDDED_NPS: an NPS score row embedded in the email.
post_cta_textstring nullable

Text displayed below the call-to-action

closing_textstring nullable

Closing paragraph of the email

signature_namestring nullable

Name displayed in the email signature

logo_urlstring uri nullable

URL of the organization logo displayed in the email header

banner_urlstring uri nullable

URL of the banner image displayed in the email

colorstring

Primary accent color for the email template (hex code)

font_family'Arial' | 'Helvetica' | 'Verdana' | 'Georgia' | 'Trebuchet'

Font family used in the email

Example request

{
  "name": "Default Template",
  "subject": "We'd love your feedback",
  "title": "How did we do?",
  "body": "Thank you for visiting us. Please take a moment to share your experience.",
  "cta_text": "Leave a review",
  "cta_type": "BUTTON",
  "post_cta_text": "Your feedback helps us improve.",
  "closing_text": "Thank you for your time!",
  "signature_name": "The Partoo Team",
  "logo_url": "https://example.com/logo.png",
  "banner_url": "https://example.com/banner.png",
  "color": "#3B82F6",
  "font_family": "Arial"
}

Response

Created

namestring required

Internal name for the template

subjectstring required

Email subject line

titlestring required

Title displayed in the email body

bodystring required

Main body text of the email

cta_textstring nullable

Call-to-action label. Required when cta_type is BUTTON.

cta_type'BUTTON' | 'EMBEDDED_NPS' required

Type of call-to-action rendered in the email.

  • BUTTON: a clickable button; cta_text must be non-null.
  • EMBEDDED_NPS: an NPS score row embedded in the email.
post_cta_textstring nullable

Text displayed below the call-to-action

closing_textstring nullable

Closing paragraph of the email

signature_namestring nullable

Name displayed in the email signature

logo_urlstring uri nullable

URL of the organization logo displayed in the email header

banner_urlstring uri nullable

URL of the banner image displayed in the email

colorstring required

Primary accent color for the email template (hex code)

font_family'Arial' | 'Helvetica' | 'Verdana' | 'Georgia' | 'Trebuchet' required

Font family used in the email

idinteger required

Unique identifier of the email template

org_idinteger required

The organization ID that owns this template

created_atstring date-time required

Date and time the template was created

updated_atstring date-time required

Date and time the template was last updated

Example response

{
  "name": "Default Template",
  "subject": "We'd love your feedback",
  "title": "How did we do?",
  "body": "Thank you for visiting us. Please take a moment to share your experience.",
  "cta_text": "Leave a review",
  "cta_type": "BUTTON",
  "post_cta_text": "Your feedback helps us improve.",
  "closing_text": "Thank you for your time!",
  "signature_name": "The Partoo Team",
  "logo_url": "https://example.com/logo.png",
  "banner_url": "https://example.com/banner.png",
  "color": "#3B82F6",
  "font_family": "Arial",
  "id": 1,
  "org_id": 42,
  "created_at": "2024-01-15T10:30:00+00:00",
  "updated_at": "2024-06-01T08:00:00+00:00"
}