Skip to main content
POST
Send a feedback email campaign

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.

Body

application/json
feedback_form_id
string
required

ID of the feedback form to associate with this campaign

Example:

"5a3f8c2e1b4d7f9a0c6e2b18"

feedback_email_template_id
integer
required

ID of the email template to use for this campaign

Example:

42

sender_email
string<email>
required

Email address displayed as the sender.

The domain of this address must be authorized for your organization and validated for email sending. If this check fails, the campaign is rejected with `status: failed` and the response includes `sender_validation` details.
Example:

"noreply@example.com"

sender_name
string
required

Name displayed as the sender

Example:

"Acme Corp"

recipients
object[]
required

List of recipients for the campaign. Maximum 1000 recipients per call. For larger lists, split them into batches and call this endpoint multiple times.

Maximum array length: 1000
is_dry_run
boolean
default:false

When true, validates the recipients without actually sending the emails. Use this to verify your recipient list before triggering a real send.

Example:

false

Response

Campaign accepted or failed validation. Check the status field to distinguish the two outcomes.

status
enum<string>
required

accepted — validation passed; emails have been enqueued (or skipped if is_dry_run was true).

failed — sender or recipient validation failed; no emails were sent. Check the error fields for details.

Available options:
accepted,
failed
Example:

"accepted"

feedback_form_id
string
required

ID of the feedback form associated with this campaign

Example:

"5a3f8c2e1b4d7f9a0c6e2b18"

feedback_email_template_id
integer
required

ID of the email template used for this campaign

Example:

42

recipient_count
integer
required

Total number of recipients provided in the request

Example:

150

feedback_email_campaign_id
integer | null

ID of the created campaign. null when status is failed or is_dry_run is true

Example:

101

duplicate_emails
string<email>[] | null

Email addresses that appear more than once in the recipients list. Populated when status is failed

Example:
invalid_emails
string[] | null

Email addresses that are not valid. Populated when status is failed

Example:
missing_variables
tuple[] | null

List of [email_address, missing_variable_names] pairs identifying recipients who are missing one or more required template variables. Populated when status is failed

Example:
empty_variables
tuple[] | null

List of [email_address, empty_variable_names] pairs identifying recipients who have one or more required template variables set to an empty string. Populated when status is failed

Example:
sender_validation
object | null

Result of the sender email validation check. Populated when status is failed. If sender_validation.status is not_validated, the sender domain is either not authorized for the organization or not validated for email sending.

Example: