v1

latestOpenAPI 3.1.0© Copyright Partoo2026-07-26163503484.0 KB

Feedback Management

Get campaign requirements

<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>

Returns the recipient fields and template variables needed to prepare a feedback email campaign for the given feedback form and email template.

Use this endpoint before Send a feedback email campaign to determine which keys to include in each recipient payload.

get/feedback/campaign/requirements

Query parameters

feedback_form_idstring required

ID of the feedback form to associate with the campaign

feedback_email_template_idinteger required

ID of the email template to inspect

Response

Campaign requirements retrieved successfully

feedback_form_idstring required

ID of the feedback form associated with the campaign

feedback_email_template_idinteger required

ID of the email template used to compute campaign requirements

recipient_fieldsstring[] required

Recipient-level fields supported by the send endpoint.

This list currently includes email_address and unsubscribe_url.

variable_fieldsstring[] required

Template variable names recipients should provide under variables, sorted alphabetically.

Example response

{
  "feedback_form_id": "5a3f8c2e1b4d7f9a0c6e2b18",
  "feedback_email_template_id": 42,
  "recipient_fields": [
    "email_address",
    "unsubscribe_url"
  ],
  "variable_fields": [
    "first_name",
    "store_code"
  ]
}