campaigns

Update Campaign Recipient

Changed on

Edit a recipient's draft / email and set a review status.

put/api/v1/campaigns/{campaign_id}/recipients/{recipient_id}

Request

  • Base URL: https://api.getanana.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.getanana.com/api/v1/campaigns/{campaign_id}/recipients/{recipient_id}
  • Auth: none declared

Path parameters

campaign_idstring uuid required
recipient_idstring uuid required

Request body

draft_subjectstring nullable
draft_bodystring nullable
emailstring nullable
status'pending' | 'drafting' | 'drafted' | 'approved' | 'skipped' | 'sending' | 'sent' | 'delivered' | 'opened' | 'clicked' | 'replied' | 'bounced' | 'failed' required

Per-recipient progress from enrollment through delivery.

Response

Successful Response

idstring uuid required
campaign_idstring uuid required
kind'customer' | 'business' required
customer_profile_idstring uuid nullable
business_idstring uuid nullable
namestring nullable
emailstring nullable
status'pending' | 'drafting' | 'drafted' | 'approved' | 'skipped' | 'sending' | 'sent' | 'delivered' | 'opened' | 'clicked' | 'replied' | 'bounced' | 'failed' required

Per-recipient progress from enrollment through delivery.

skip_reasonstring nullable
draft_subjectstring nullable
draft_bodystring nullable
grounding_summarystring nullable
review_flagsstring[]
artifact_idstring uuid nullable
resend_message_idstring nullable
error_messagestring nullable
created_atstring date-time required
updated_atstring date-time required

Changes

  • d65b8fefae34Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status