Send a feedback email campaign
Validates the sender email, validates recipients, and sends a feedback email campaign to the provided recipient list.
Use the Get campaign requirements endpoint to retrieve the variables each recipient must provide.
The sender email domain must be authorized for your organization and validated for email sending.
If sender validation fails, the entire campaign is rejected and the response includes sender_validation details.
If any recipient fails validation, the entire campaign is rejected and no emails are sent. The response body details every validation error.
Set is_dry_run: true to validate recipients without sending any emails.
Authorizations
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
ID of the feedback form to associate with this campaign
"5a3f8c2e1b4d7f9a0c6e2b18"
ID of the email template to use for this campaign
42
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."noreply@example.com"
Name displayed as the sender
"Acme Corp"
List of recipients for the campaign. Maximum 1000 recipients per call. For larger lists, split them into batches and call this endpoint multiple times.
1000When true, validates the recipients without actually sending the emails.
Use this to verify your recipient list before triggering a real send.
false
Response
Campaign accepted or failed validation. Check the status field to distinguish the two outcomes.
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.
accepted, failed "accepted"
ID of the feedback form associated with this campaign
"5a3f8c2e1b4d7f9a0c6e2b18"
ID of the email template used for this campaign
42
Total number of recipients provided in the request
150
ID of the created campaign. null when status is failed or is_dry_run is true
101
Email addresses that appear more than once in the recipients list. Populated when status is failed
Email addresses that are not valid. Populated when status is failed
List of [email_address, missing_variable_names] pairs identifying recipients
who are missing one or more required template variables. Populated when status is failed
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
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.