ghl_conversation_update_email_message_status
Update email message delivery status, including aggregate events and per-recipient outcomes, for custom conversation providers.
Instructions
Update email message status Update delivery events, per-recipient statuses, and the overall message status for an email sent via a custom conversation provider.
Authorization
Requires the
conversations/message.writeOAuth scope.The calling OAuth app must own the conversation provider that originally sent the email.
Attempts to update emails sent via LC Email or Mailgun will return
403 Forbidden.
Updatable Fields
status is required on every request. You may also include events and/or recipients.
events — Aggregate delivery event counters (integers). Counters are merged into th
Endpoint: PUT /conversations/messages/email/{id}/status (Version header: v3; source: v3/conversations-v3.json)
OAuth scopes: conversations/message.write
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Email message id | |
| body | Yes | Request body to update the delivery status of an email message. `status` is required. `events` and `recipients` are optional and may be included together with `status`. - Use `events` to report aggregate delivery metrics (delivered count, open count, etc.). - Use `recipients` to track per-recipient delivery outcomes for multi-recipient emails. - Use `status` to set the overall message status. Multiple calls are additive — event counters are merged, recipient statuses are upserted, and the message status is overwritten. |