Skip to main content
GET
Get campaign requirements

Authorizations

x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Query Parameters

feedback_form_id
string
required

ID of the feedback form to associate with the campaign

feedback_email_template_id
integer
required

ID of the email template to inspect

Response

Campaign requirements retrieved successfully

feedback_form_id
string
required

ID of the feedback form associated with the campaign

Example:

"5a3f8c2e1b4d7f9a0c6e2b18"

feedback_email_template_id
integer
required

ID of the email template used to compute campaign requirements

Example:

42

recipient_fields
enum<string>[]
required

Recipient-level fields supported by the send endpoint.

This list currently includes email_address and unsubscribe_url.

Available options:
email_address,
unsubscribe_url
Example:
variable_fields
string[]
required

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

Example: