Create a Campaign Bounce
Manually register a bounce event for a subscriber within a campaign. Useful for syncing external bounce events into SenderWiz.
🛑 Create a Campaign Bounce
Use this endpoint to create and log a bounce for a subscriber under a specific campaign.
🔹 HTTP Request
POST API-URL/campaigns/CAMPAIGN-UNIQUE-ID/bounces
🔸 URL Segments
Segment
Required
Description
CAMPAIGN-UNIQUE-ID
Yes
Campaign unique ID to create the bounce for.
📝 POST Parameters
Parameter
Required
Description
message
Yes
Bounce reason (max 250 characters).
bounce_type
Yes
Bounce type: hard
, soft
, or internal
.
subscriber_uid
Yes
Subscriber's unique ID (13 characters).
🔐 Authorization Header
X-API-KEY: your-api-key-here
💻 PHP Example
// CREATE BOUNCE
$response = $endpoint->create('CAMPAIGN-UNIQUE-ID', [
'message' => 'The reason why this email bounced', // max 250 chars
'bounce_type' => 'hard', // hard, soft or internal
'subscriber_uid' => 'SUBSCRIBER-UNIQUE-ID' // 13 chars unique subscriber identifier
]);
// DISPLAY RESPONSE
echo '<hr /><pre>';
print_r($response->body);
echo '</pre>';
📦 Sample JSON Response
{
"status": "success",
"data": {
"record": {
"message": "550 5.1.1 The email account that you tried to reach does not exist.",
"processed": "no",
"bounce_type": "hard",
"subscriber": {
"subscriber_uid": "lk572qwmzv410",
"email": "[email protected]"
}
}
}
}
Last updated