Pause or unpause recipient
Stop or restart the emails of one recipient in one campaign and keep the rest of the campaign running.
POST https://cotlet.dev/api/v1/mailshake/campaigns/{campaign_id}/recipient/pause
write
Pauses one recipient in one campaign by email address, or unpauses them with paused false. An email being sent at that moment is not stopped. A reply stops follow-ups but not drip emails, so this is how you stop a drip for someone who booked a meeting. Unpausing reschedules their pending emails. It reaches no one and one more call reverses it, so it does not wait for your OK. A recipient not in the campaign comes back as not_found.
Parameters
| Name | Type | Description |
|---|---|---|
| campaign_id integer required | integer | The campaign the recipient is in. |
| email_address string required | string | The recipient's email address. |
| paused boolean | boolean | true to pause, false to unpause. Default: true. |
Request
curl -X POST https://cotlet.dev/api/v1/mailshake/campaigns/1/recipient/pause \
-H "Authorization: Bearer $COTLET_API_KEY" \
-H "Content-Type: application/json" \
-d '{"email_address":"jane@example.com"}'result = client.call("mailshake", "pause_recipient", {"campaign_id":1,"email_address":"jane@example.com"})const result = await cotlet.call('mailshake', 'pause_recipient', {"campaign_id":1,"email_address":"jane@example.com"});cotlet call mailshake pause_recipient --data '{"campaign_id":1,"email_address":"jane@example.com"}'Example response
{
"campaign_id": 4821,
"email_address": "omar@lumenlabs.example",
"is_paused": true
}