> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # resend-messaging > Resend Messaging - send emails, manage broadcasts, templates, automations, and view events/logs **Server path:** `/resend-messaging` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | | [`resend_messaging_delete_automations_by_automation_id`](#resend_messaging_delete_automations_by_automation_id) | Delete an automation | | [`resend_messaging_delete_broadcasts_by_id`](#resend_messaging_delete_broadcasts_by_id) | Remove an existing broadcast that is in the draft status | | [`resend_messaging_delete_events_by_identifier`](#resend_messaging_delete_events_by_identifier) | Delete an event | | [`resend_messaging_delete_templates_by_id`](#resend_messaging_delete_templates_by_id) | Remove an existing template | | [`resend_messaging_get_automations`](#resend_messaging_get_automations) | Retrieve a list of automations | | [`resend_messaging_get_automations_by_automation_id`](#resend_messaging_get_automations_by_automation_id) | Retrieve a single automation | | [`resend_messaging_get_automations_by_automation_id_runs`](#resend_messaging_get_automations_by_automation_id_runs) | Retrieve a list of automation runs | | [`resend_messaging_get_automations_by_automation_id_runs_by_run_id`](#resend_messaging_get_automations_by_automation_id_runs_by_run_id) | Retrieve a single automation run | | [`resend_messaging_get_broadcasts`](#resend_messaging_get_broadcasts) | Retrieve a list of broadcasts | | [`resend_messaging_get_broadcasts_by_id`](#resend_messaging_get_broadcasts_by_id) | Retrieve a single broadcast | | [`resend_messaging_get_emails`](#resend_messaging_get_emails) | Retrieve a list of emails | | [`resend_messaging_get_emails_by_email_id`](#resend_messaging_get_emails_by_email_id) | Retrieve a single email | | [`resend_messaging_get_emails_by_email_id_attachments`](#resend_messaging_get_emails_by_email_id_attachments) | Retrieve a list of attachments for a sent email | | [`resend_messaging_get_emails_by_email_id_attachments_by_attachment_id`](#resend_messaging_get_emails_by_email_id_attachments_by_attachment_id) | Retrieve a single attachment for a sent email | | [`resend_messaging_get_emails_receiving`](#resend_messaging_get_emails_receiving) | Retrieve a list of received emails | | [`resend_messaging_get_emails_receiving_by_email_id`](#resend_messaging_get_emails_receiving_by_email_id) | Retrieve a single received email | | [`resend_messaging_get_emails_receiving_by_email_id_attachments`](#resend_messaging_get_emails_receiving_by_email_id_attachments) | Retrieve a list of attachments for a received email | | [`resend_messaging_get_emails_receiving_by_email_id_attachments_by_attachment_id`](#resend_messaging_get_emails_receiving_by_email_id_attachments_by_attachment_id) | Retrieve a single attachment for a received email | | [`resend_messaging_get_events`](#resend_messaging_get_events) | Retrieve a list of events | | [`resend_messaging_get_events_by_identifier`](#resend_messaging_get_events_by_identifier) | Retrieve a single event | | [`resend_messaging_get_logs`](#resend_messaging_get_logs) | Retrieve a list of logs | | [`resend_messaging_get_logs_by_log_id`](#resend_messaging_get_logs_by_log_id) | Retrieve a single log | | [`resend_messaging_get_templates`](#resend_messaging_get_templates) | Retrieve a list of templates | | [`resend_messaging_get_templates_by_id`](#resend_messaging_get_templates_by_id) | Retrieve a single template | | [`resend_messaging_patch_automations_by_automation_id`](#resend_messaging_patch_automations_by_automation_id) | Update an automation | | [`resend_messaging_patch_broadcasts_by_id`](#resend_messaging_patch_broadcasts_by_id) | Update an existing broadcast | | [`resend_messaging_patch_emails_by_email_id`](#resend_messaging_patch_emails_by_email_id) | Update a single email | | [`resend_messaging_patch_events_by_identifier`](#resend_messaging_patch_events_by_identifier) | Update an event | | [`resend_messaging_patch_templates_by_id`](#resend_messaging_patch_templates_by_id) | Update an existing template | | [`resend_messaging_post_automations`](#resend_messaging_post_automations) | Create an automation | | [`resend_messaging_post_automations_by_automation_id_stop`](#resend_messaging_post_automations_by_automation_id_stop) | Stop an automation | | [`resend_messaging_post_broadcasts`](#resend_messaging_post_broadcasts) | Create a broadcast | | [`resend_messaging_post_broadcasts_by_id_send`](#resend_messaging_post_broadcasts_by_id_send) | Send or schedule a broadcast | | [`resend_messaging_post_emails`](#resend_messaging_post_emails) | Send an email | | [`resend_messaging_post_emails_batch`](#resend_messaging_post_emails_batch) | Trigger up to 100 batch emails at once. | | [`resend_messaging_post_emails_by_email_id_cancel`](#resend_messaging_post_emails_by_email_id_cancel) | Cancel the schedule of the e-mail. | | [`resend_messaging_post_events`](#resend_messaging_post_events) | Create an event | | [`resend_messaging_post_events_send`](#resend_messaging_post_events_send) | Send an event | | [`resend_messaging_post_templates`](#resend_messaging_post_templates) | Create a template | | [`resend_messaging_post_templates_by_id_duplicate`](#resend_messaging_post_templates_by_id_duplicate) | Duplicate a template | | [`resend_messaging_post_templates_by_id_publish`](#resend_messaging_post_templates_by_id_publish) | Publish a template | *** ## resend\_messaging\_delete\_automations\_by\_automation\_id Delete an automation **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ------------------------- | | `automation_id` | string | Yes | — | The ID of the automation. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "automation_id": { "type": "string", "description": "The ID of the automation." } }, "required": [ "PCID", "automation_id" ] } ``` *** ## resend\_messaging\_delete\_broadcasts\_by\_id Remove an existing broadcast that is in the draft status **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------------- | | `id` | string | Yes | — | The Broadcast ID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The Broadcast ID." } }, "required": [ "PCID", "id" ] } ``` *** ## resend\_messaging\_delete\_events\_by\_identifier Delete an event **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ---------------------------------- | | `identifier` | string | Yes | — | The event ID (UUID) or event name. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "The event ID (UUID) or event name." } }, "required": [ "PCID", "identifier" ] } ``` *** ## resend\_messaging\_delete\_templates\_by\_id Remove an existing template **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------- | | `id` | string | Yes | — | The Template ID or alias. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The Template ID or alias." } }, "required": [ "PCID", "id" ] } ``` *** ## resend\_messaging\_get\_automations Retrieve a list of automations **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | -------------------------------- | | `status` | string | No | — | Filter automations by status. | | `limit` | integer | No | — | Number of items to return. | | `after` | string | No | — | Return items after this cursor. | | `before` | string | No | — | Return items before this cursor. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "status": { "type": "string", "description": "Filter automations by status.", "enum": [ "enabled", "disabled" ] }, "limit": { "type": "integer", "description": "Number of items to return." }, "after": { "type": "string", "description": "Return items after this cursor." }, "before": { "type": "string", "description": "Return items before this cursor." } }, "required": [ "PCID" ] } ``` *** ## resend\_messaging\_get\_automations\_by\_automation\_id Retrieve a single automation **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ------------------------- | | `automation_id` | string | Yes | — | The ID of the automation. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "automation_id": { "type": "string", "description": "The ID of the automation." } }, "required": [ "PCID", "automation_id" ] } ``` *** ## resend\_messaging\_get\_automations\_by\_automation\_id\_runs Retrieve a list of automation runs **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------- | | `automation_id` | string | Yes | — | The ID of the automation. | | `status` | string | No | — | Filter runs by status. Comma-separated list of: running, completed, failed, cancelled. | | `limit` | integer | No | — | Number of items to return. | | `after` | string | No | — | Return items after this cursor. | | `before` | string | No | — | Return items before this cursor. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "automation_id": { "type": "string", "description": "The ID of the automation." }, "status": { "type": "string", "description": "Filter runs by status. Comma-separated list of: running, completed, failed, cancelled." }, "limit": { "type": "integer", "description": "Number of items to return." }, "after": { "type": "string", "description": "Return items after this cursor." }, "before": { "type": "string", "description": "Return items before this cursor." } }, "required": [ "PCID", "automation_id" ] } ``` *** ## resend\_messaging\_get\_automations\_by\_automation\_id\_runs\_by\_run\_id Retrieve a single automation run **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ----------------------------- | | `automation_id` | string | Yes | — | The ID of the automation. | | `run_id` | string | Yes | — | The ID of the automation run. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "automation_id": { "type": "string", "description": "The ID of the automation." }, "run_id": { "type": "string", "description": "The ID of the automation run." } }, "required": [ "PCID", "automation_id", "run_id" ] } ``` *** ## resend\_messaging\_get\_broadcasts Retrieve a list of broadcasts **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | -------------------------------- | | `limit` | integer | No | — | Number of items to return. | | `after` | string | No | — | Return items after this cursor. | | `before` | string | No | — | Return items before this cursor. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Number of items to return." }, "after": { "type": "string", "description": "Return items after this cursor." }, "before": { "type": "string", "description": "Return items before this cursor." } }, "required": [ "PCID" ] } ``` *** ## resend\_messaging\_get\_broadcasts\_by\_id Retrieve a single broadcast **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------------- | | `id` | string | Yes | — | The Broadcast ID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The Broadcast ID." } }, "required": [ "PCID", "id" ] } ``` *** ## resend\_messaging\_get\_emails Retrieve a list of emails **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | -------------------------------- | | `limit` | integer | No | — | Number of items to return. | | `after` | string | No | — | Return items after this cursor. | | `before` | string | No | — | Return items before this cursor. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Number of items to return." }, "after": { "type": "string", "description": "Return items after this cursor." }, "before": { "type": "string", "description": "Return items before this cursor." } }, "required": [ "PCID" ] } ``` *** ## resend\_messaging\_get\_emails\_by\_email\_id Retrieve a single email **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | -------------------- | | `email_id` | string | Yes | — | The ID of the email. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "email_id": { "type": "string", "description": "The ID of the email." } }, "required": [ "PCID", "email_id" ] } ``` *** ## resend\_messaging\_get\_emails\_by\_email\_id\_attachments Retrieve a list of attachments for a sent email **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------ | | `email_id` | string | Yes | — | The ID of the email. | | `limit` | integer | No | — | Maximum number of attachments to return. | | `after` | string | No | — | Pagination cursor to fetch results after this attachment ID. Cannot be used with 'before'. | | `before` | string | No | — | Pagination cursor to fetch results before this attachment ID. Cannot be used with 'after'. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "email_id": { "type": "string", "description": "The ID of the email." }, "limit": { "type": "integer", "description": "Maximum number of attachments to return." }, "after": { "type": "string", "description": "Pagination cursor to fetch results after this attachment ID. Cannot be used with 'before'." }, "before": { "type": "string", "description": "Pagination cursor to fetch results before this attachment ID. Cannot be used with 'after'." } }, "required": [ "PCID", "email_id" ] } ``` *** ## resend\_messaging\_get\_emails\_by\_email\_id\_attachments\_by\_attachment\_id Retrieve a single attachment for a sent email **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ------------------------- | | `email_id` | string | Yes | — | The ID of the email. | | `attachment_id` | string | Yes | — | The ID of the attachment. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "email_id": { "type": "string", "description": "The ID of the email." }, "attachment_id": { "type": "string", "description": "The ID of the attachment." } }, "required": [ "PCID", "email_id", "attachment_id" ] } ``` *** ## resend\_messaging\_get\_emails\_receiving Retrieve a list of received emails **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------- | | `limit` | integer | No | — | Maximum number of received emails to return. | | `after` | string | No | — | Pagination cursor to fetch results after this email ID. Cannot be used with 'before'. | | `before` | string | No | — | Pagination cursor to fetch results before this email ID. Cannot be used with 'after'. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Maximum number of received emails to return." }, "after": { "type": "string", "description": "Pagination cursor to fetch results after this email ID. Cannot be used with 'before'." }, "before": { "type": "string", "description": "Pagination cursor to fetch results before this email ID. Cannot be used with 'after'." } }, "required": [ "PCID" ] } ``` *** ## resend\_messaging\_get\_emails\_receiving\_by\_email\_id Retrieve a single received email **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ----------------------------- | | `email_id` | string | Yes | — | The ID of the received email. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "email_id": { "type": "string", "description": "The ID of the received email." } }, "required": [ "PCID", "email_id" ] } ``` *** ## resend\_messaging\_get\_emails\_receiving\_by\_email\_id\_attachments Retrieve a list of attachments for a received email **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------ | | `email_id` | string | Yes | — | The ID of the received email. | | `limit` | integer | No | — | Maximum number of attachments to return. | | `after` | string | No | — | Pagination cursor to fetch results after this attachment ID. Cannot be used with 'before'. | | `before` | string | No | — | Pagination cursor to fetch results before this attachment ID. Cannot be used with 'after'. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "email_id": { "type": "string", "description": "The ID of the received email." }, "limit": { "type": "integer", "description": "Maximum number of attachments to return." }, "after": { "type": "string", "description": "Pagination cursor to fetch results after this attachment ID. Cannot be used with 'before'." }, "before": { "type": "string", "description": "Pagination cursor to fetch results before this attachment ID. Cannot be used with 'after'." } }, "required": [ "PCID", "email_id" ] } ``` *** ## resend\_messaging\_get\_emails\_receiving\_by\_email\_id\_attachments\_by\_attachment\_id Retrieve a single attachment for a received email **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ----------------------------- | | `email_id` | string | Yes | — | The ID of the received email. | | `attachment_id` | string | Yes | — | The ID of the attachment. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "email_id": { "type": "string", "description": "The ID of the received email." }, "attachment_id": { "type": "string", "description": "The ID of the attachment." } }, "required": [ "PCID", "email_id", "attachment_id" ] } ``` *** ## resend\_messaging\_get\_events Retrieve a list of events **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | -------------------------------- | | `limit` | integer | No | — | Number of items to return. | | `after` | string | No | — | Return items after this cursor. | | `before` | string | No | — | Return items before this cursor. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Number of items to return." }, "after": { "type": "string", "description": "Return items after this cursor." }, "before": { "type": "string", "description": "Return items before this cursor." } }, "required": [ "PCID" ] } ``` *** ## resend\_messaging\_get\_events\_by\_identifier Retrieve a single event **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ---------------------------------- | | `identifier` | string | Yes | — | The event ID (UUID) or event name. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "The event ID (UUID) or event name." } }, "required": [ "PCID", "identifier" ] } ``` *** ## resend\_messaging\_get\_logs Retrieve a list of logs **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | -------------------------------- | | `limit` | integer | No | — | Number of items to return. | | `after` | string | No | — | Return items after this cursor. | | `before` | string | No | — | Return items before this cursor. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Number of items to return." }, "after": { "type": "string", "description": "Return items after this cursor." }, "before": { "type": "string", "description": "Return items before this cursor." } }, "required": [ "PCID" ] } ``` *** ## resend\_messaging\_get\_logs\_by\_log\_id Retrieve a single log **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------ | | `log_id` | string | Yes | — | The ID of the log. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "log_id": { "type": "string", "description": "The ID of the log." } }, "required": [ "PCID", "log_id" ] } ``` *** ## resend\_messaging\_get\_templates Retrieve a list of templates **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | -------------------------------- | | `limit` | integer | No | — | Number of items to return. | | `after` | string | No | — | Return items after this cursor. | | `before` | string | No | — | Return items before this cursor. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Number of items to return." }, "after": { "type": "string", "description": "Return items after this cursor." }, "before": { "type": "string", "description": "Return items before this cursor." } }, "required": [ "PCID" ] } ``` *** ## resend\_messaging\_get\_templates\_by\_id Retrieve a single template **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------- | | `id` | string | Yes | — | The Template ID or alias. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The Template ID or alias." } }, "required": [ "PCID", "id" ] } ``` *** ## resend\_messaging\_patch\_automations\_by\_automation\_id Update an automation **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | | `automation_id` | string | Yes | — | The ID of the automation. | | `connections` | object\[] | No | — | The connections between steps in the automation graph. Must be provided together with `steps`. | | `name` | string | No | — | The name of the automation. | | `status` | string | No | — | The status of the automation. | | `steps` | object\[] | No | — | The steps that compose the automation workflow. Must be provided together with `connections`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "automation_id": { "type": "string", "description": "The ID of the automation." }, "connections": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string", "description": "The `key` of the source step." }, "to": { "type": "string", "description": "The `key` of the target step." }, "type": { "type": "string", "enum": [ "default", "condition_met", "condition_not_met", "timeout", "event_received" ], "description": "The type of connection. Defaults to `default`." } }, "required": [ "from", "to" ] }, "description": "The connections between steps in the automation graph. Must be provided together with `steps`." }, "name": { "type": "string", "description": "The name of the automation." }, "status": { "type": "string", "description": "The status of the automation.", "enum": [ "enabled", "disabled" ] }, "steps": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A unique key for this step within the automation graph." }, "type": { "type": "string", "enum": [ "trigger", "send_email", "delay", "wait_for_event", "condition", "contact_update", "contact_delete", "add_to_segment" ], "description": "The type of automation step." }, "config": { "type": "object", "description": "Configuration for the step. Shape depends on `type`: - **trigger**: `{ event_name: string }` - **send_email**: `{ template: { id: string, variables?: object }, subject?: string, from?: string, reply_to?: string }` - **delay**: `{ duration: string }` — a human-readable duration (e.g. `\"30 minutes\"`) - **wait_for_event**: `{ event_name: string, timeout?: string, filter_rule?: object }` — `timeout` is a human-readable duration (e.g. `\"1 hour\"`) - **condition**: A rule tree with `type` (`rule`, `and`, `or`), `field`, `operator`, and `value` - **contact_update**: `{ first_name?: string|object, last_name?: string|object, unsubscribed?: boolean|object, properties?: object }` - **contact_delete**: `{}` - **add_to_segment**: `{ segment_id: string }`" } }, "required": [ "key", "type", "config" ] }, "description": "The steps that compose the automation workflow. Must be provided together with `connections`." } }, "required": [ "PCID", "automation_id" ] } ``` *** ## resend\_messaging\_patch\_broadcasts\_by\_id Update an existing broadcast **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------- | | `id` | string | Yes | — | The Broadcast ID. | | `audience_id` | string | No | — | Use `segment_id` instead. Unique identifier of the audience this broadcast will be sent to. | | `from` | string | No | — | The email address of the sender. | | `html` | string | No | — | The HTML version of the message. | | `name` | string | No | — | Name of the broadcast. | | `preview_text` | string | No | — | The preview text of the email. | | `reply_to` | string\[] | No | — | The email addresses to which replies should be sent. | | `segment_id` | string | No | — | Unique identifier of the segment this broadcast will be sent to. | | `subject` | string | No | — | The subject line of the email. | | `text` | string | No | — | The plain text version of the message. | | `topic_id` | string | No | — | The topic ID that the broadcast will be scoped to. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The Broadcast ID." }, "audience_id": { "type": "string", "description": "Use `segment_id` instead. Unique identifier of the audience this broadcast will be sent to." }, "from": { "type": "string", "description": "The email address of the sender." }, "html": { "type": "string", "description": "The HTML version of the message." }, "name": { "type": "string", "description": "Name of the broadcast." }, "preview_text": { "type": "string", "description": "The preview text of the email." }, "reply_to": { "type": "array", "items": { "type": "string" }, "description": "The email addresses to which replies should be sent." }, "segment_id": { "type": "string", "description": "Unique identifier of the segment this broadcast will be sent to." }, "subject": { "type": "string", "description": "The subject line of the email." }, "text": { "type": "string", "description": "The plain text version of the message." }, "topic_id": { "type": "string", "description": "The topic ID that the broadcast will be scoped to." } }, "required": [ "PCID", "id" ] } ``` *** ## resend\_messaging\_patch\_emails\_by\_email\_id Update a single email **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ----------------------------------------------------------------------- | | `email_id` | string | Yes | — | The ID of the email. | | `scheduled_at` | string | Yes | — | Schedule email to be sent later. The date should be in ISO 8601 format. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "email_id": { "type": "string", "description": "The ID of the email." }, "scheduled_at": { "type": "string", "description": "Schedule email to be sent later. The date should be in ISO 8601 format." } }, "required": [ "PCID", "email_id", "scheduled_at" ] } ``` *** ## resend\_messaging\_patch\_events\_by\_identifier Update an event **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | | `identifier` | string | Yes | — | The event ID (UUID) or event name. | | `schema` | object | Yes | — | A flat key/type map defining the event payload schema. Set to `null` to clear the schema. Supported types are `string`, `number`, `boolean`, and `date`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "The event ID (UUID) or event name." }, "schema": { "type": "object", "description": "A flat key/type map defining the event payload schema. Set to `null` to clear the schema. Supported types are `string`, `number`, `boolean`, and `date`." } }, "required": [ "PCID", "identifier", "schema" ] } ``` *** ## resend\_messaging\_patch\_templates\_by\_id Update an existing template **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `id` | string | Yes | — | The Template ID or alias. | | `alias` | string | No | — | The alias of the template. | | `from` | string | No | — | Sender email address. To include a friendly name, use the format "Your Name \<[sender@domain.com](mailto:sender@domain.com)>". | | `html` | string | No | — | The HTML version of the template. | | `name` | string | No | — | The name of the template. | | `reply_to` | string\[] | No | — | Reply-to email addresses. | | `subject` | string | No | — | Email subject. | | `text` | string | No | — | The plain text version of the template. | | `variables` | object\[] | No | — | The variables value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The Template ID or alias." }, "alias": { "type": "string", "description": "The alias of the template." }, "from": { "type": "string", "description": "Sender email address. To include a friendly name, use the format \"Your Name \"." }, "html": { "type": "string", "description": "The HTML version of the template." }, "name": { "type": "string", "description": "The name of the template." }, "reply_to": { "type": "array", "items": { "type": "string" }, "description": "Reply-to email addresses." }, "subject": { "type": "string", "description": "Email subject." }, "text": { "type": "string", "description": "The plain text version of the template." }, "variables": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the variable." }, "type": { "type": "string", "enum": [ "string", "number", "boolean", "object", "list" ], "description": "The type of the variable." }, "fallback_value": { "description": "The fallback value of the variable." } }, "required": [ "key", "type" ] }, "description": "The variables value" } }, "required": [ "PCID", "id" ] } ``` *** ## resend\_messaging\_post\_automations Create an automation **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------- | | `connections` | object\[] | Yes | — | The connections between steps in the automation graph. | | `name` | string | Yes | — | The name of the automation. | | `status` | string | No | — | The initial status of the automation. Defaults to `disabled`. | | `steps` | object\[] | Yes | — | The steps that compose the automation workflow. Must include at least one `trigger` step. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "connections": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string", "description": "The `key` of the source step." }, "to": { "type": "string", "description": "The `key` of the target step." }, "type": { "type": "string", "enum": [ "default", "condition_met", "condition_not_met", "timeout", "event_received" ], "description": "The type of connection. Defaults to `default`." } }, "required": [ "from", "to" ] }, "description": "The connections between steps in the automation graph." }, "name": { "type": "string", "description": "The name of the automation." }, "status": { "type": "string", "description": "The initial status of the automation. Defaults to `disabled`.", "enum": [ "enabled", "disabled" ] }, "steps": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A unique key for this step within the automation graph." }, "type": { "type": "string", "enum": [ "trigger", "send_email", "delay", "wait_for_event", "condition", "contact_update", "contact_delete", "add_to_segment" ], "description": "The type of automation step." }, "config": { "type": "object", "description": "Configuration for the step. Shape depends on `type`: - **trigger**: `{ event_name: string }` - **send_email**: `{ template: { id: string, variables?: object }, subject?: string, from?: string, reply_to?: string }` - **delay**: `{ duration: string }` — a human-readable duration (e.g. `\"30 minutes\"`) - **wait_for_event**: `{ event_name: string, timeout?: string, filter_rule?: object }` — `timeout` is a human-readable duration (e.g. `\"1 hour\"`) - **condition**: A rule tree with `type` (`rule`, `and`, `or`), `field`, `operator`, and `value` - **contact_update**: `{ first_name?: string|object, last_name?: string|object, unsubscribed?: boolean|object, properties?: object }` - **contact_delete**: `{}` - **add_to_segment**: `{ segment_id: string }`" } }, "required": [ "key", "type", "config" ] }, "description": "The steps that compose the automation workflow. Must include at least one `trigger` step." } }, "required": [ "PCID", "connections", "name", "steps" ] } ``` *** ## resend\_messaging\_post\_automations\_by\_automation\_id\_stop Stop an automation **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ------------------------- | | `automation_id` | string | Yes | — | The ID of the automation. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "automation_id": { "type": "string", "description": "The ID of the automation." } }, "required": [ "PCID", "automation_id" ] } ``` *** ## resend\_messaging\_post\_broadcasts Create a broadcast **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------ | | `audience_id` | string | No | — | Use `segment_id` instead. Unique identifier of the segment this broadcast will be sent to. | | `from` | string | Yes | — | The email address of the sender. | | `html` | string | No | — | The HTML version of the message. | | `name` | string | No | — | Name of the broadcast. | | `preview_text` | string | No | — | The preview text of the email. | | `reply_to` | string\[] | No | — | The email addresses to which replies should be sent. | | `scheduled_at` | string | No | — | Schedule time to send the broadcast. Can only be used if `send` is true. | | `segment_id` | string | Yes | — | Unique identifier of the segment this broadcast will be sent to. | | `send` | boolean | No | — | Whether to send the broadcast immediately or keep it as a draft. | | `subject` | string | Yes | — | The subject line of the email. | | `text` | string | No | — | The plain text version of the message. | | `topic_id` | string | No | — | The topic ID that the broadcast will be scoped to. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "audience_id": { "type": "string", "description": "Use `segment_id` instead. Unique identifier of the segment this broadcast will be sent to." }, "from": { "type": "string", "description": "The email address of the sender." }, "html": { "type": "string", "description": "The HTML version of the message." }, "name": { "type": "string", "description": "Name of the broadcast." }, "preview_text": { "type": "string", "description": "The preview text of the email." }, "reply_to": { "type": "array", "items": { "type": "string" }, "description": "The email addresses to which replies should be sent." }, "scheduled_at": { "type": "string", "description": "Schedule time to send the broadcast. Can only be used if `send` is true." }, "segment_id": { "type": "string", "description": "Unique identifier of the segment this broadcast will be sent to." }, "send": { "type": "boolean", "description": "Whether to send the broadcast immediately or keep it as a draft." }, "subject": { "type": "string", "description": "The subject line of the email." }, "text": { "type": "string", "description": "The plain text version of the message." }, "topic_id": { "type": "string", "description": "The topic ID that the broadcast will be scoped to." } }, "required": [ "PCID", "from", "segment_id", "subject" ] } ``` *** ## resend\_messaging\_post\_broadcasts\_by\_id\_send Send or schedule a broadcast **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ----------------------------------------------------------------------- | | `id` | string | Yes | — | The Broadcast ID. | | `scheduled_at` | string | No | — | Schedule email to be sent later. The date should be in ISO 8601 format. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The Broadcast ID." }, "scheduled_at": { "type": "string", "description": "Schedule email to be sent later. The date should be in ISO 8601 format." } }, "required": [ "PCID", "id" ] } ``` *** ## resend\_messaging\_post\_emails Send an email **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Idempotency-Key` | string | No | — | A unique identifier for the request to ensure emails are only sent once. [Learn more](https://resend.com/docs/dashboard/emails/idempotency-keys) | | `attachments` | object\[] | No | — | The attachments value | | `bcc` | string\[] | No | — | Bcc recipient email address. For multiple addresses, send as an array of strings. | | `cc` | string\[] | No | — | Cc recipient email address. For multiple addresses, send as an array of strings. | | `from` | string | Yes | — | Sender email address. To include a friendly name, use the format "Your Name \<[sender@domain.com](mailto:sender@domain.com)>". | | `headers` | object | No | — | Custom headers to add to the email. | | `html` | string | No | — | The HTML version of the message. | | `reply_to` | string\[] | No | — | Reply-to email address. For multiple addresses, send as an array of strings. | | `scheduled_at` | string | No | — | Schedule email to be sent later. The date should be in ISO 8601 format. | | `subject` | string | Yes | — | Email subject. | | `tags` | object\[] | No | — | The tags value | | `template` | object | No | — | The template value | | `text` | string | No | — | The plain text version of the message. | | `to` | string\[] | Yes | — | Recipient email address. For multiple addresses, send as an array of strings. Max 50. | | `topic_id` | string | No | — | The topic ID to scope the email to. If the recipient is a contact and opted-in to the topic, the email is sent. If opted-out, the email is not sent. If the recipient is not a contact, the email is sent if the topic's default subscription is opt\_in. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "Idempotency-Key": { "type": "string", "description": "A unique identifier for the request to ensure emails are only sent once. [Learn more](https://resend.com/docs/dashboard/emails/idempotency-keys)" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "content": { "type": "string", "format": "binary", "description": "Content of an attached file." }, "filename": { "type": "string", "description": "Name of attached file." }, "path": { "type": "string", "description": "Path where the attachment file is hosted" }, "content_type": { "type": "string", "description": "Optional content type for the attachment, if not set it will be derived from the filename property" }, "content_id": { "type": "string", "description": "Content ID for embedding inline images using cid references (e.g., cid:image001)." } } }, "description": "The attachments value" }, "bcc": { "type": "array", "items": { "type": "string" }, "description": "Bcc recipient email address. For multiple addresses, send as an array of strings." }, "cc": { "type": "array", "items": { "type": "string" }, "description": "Cc recipient email address. For multiple addresses, send as an array of strings." }, "from": { "type": "string", "description": "Sender email address. To include a friendly name, use the format \"Your Name \"." }, "headers": { "type": "object", "description": "Custom headers to add to the email." }, "html": { "type": "string", "description": "The HTML version of the message." }, "reply_to": { "type": "array", "items": { "type": "string" }, "description": "Reply-to email address. For multiple addresses, send as an array of strings." }, "scheduled_at": { "type": "string", "description": "Schedule email to be sent later. The date should be in ISO 8601 format." }, "subject": { "type": "string", "description": "Email subject." }, "tags": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the email tag. It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 256 characters." }, "value": { "type": "string", "description": "The value of the email tag.It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 256 characters." } } }, "description": "The tags value" }, "template": { "description": "The template value" }, "text": { "type": "string", "description": "The plain text version of the message." }, "to": { "type": "array", "items": { "type": "string" }, "description": "Recipient email address. For multiple addresses, send as an array of strings. Max 50." }, "topic_id": { "type": "string", "description": "The topic ID to scope the email to. If the recipient is a contact and opted-in to the topic, the email is sent. If opted-out, the email is not sent. If the recipient is not a contact, the email is sent if the topic's default subscription is opt_in." } }, "required": [ "PCID", "from", "subject", "to" ] } ``` *** ## resend\_messaging\_post\_emails\_batch Trigger up to 100 batch emails at once. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `Idempotency-Key` | string | No | — | A unique identifier for the request to ensure emails are only sent once. [Learn more](https://resend.com/docs/dashboard/emails/idempotency-keys) | | `body` | object\[] | No | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "Idempotency-Key": { "type": "string", "description": "A unique identifier for the request to ensure emails are only sent once. [Learn more](https://resend.com/docs/dashboard/emails/idempotency-keys)" }, "body": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string", "description": "Sender email address. To include a friendly name, use the format \"Your Name \"." }, "to": { "type": "array", "items": { "type": "string" }, "description": "Recipient email address. For multiple addresses, send as an array of strings. Max 50." }, "subject": { "type": "string", "description": "Email subject." }, "bcc": { "type": "array", "items": { "type": "string" }, "description": "Bcc recipient email address. For multiple addresses, send as an array of strings." }, "cc": { "type": "array", "items": { "type": "string" }, "description": "Cc recipient email address. For multiple addresses, send as an array of strings." }, "reply_to": { "type": "array", "items": { "type": "string" }, "description": "Reply-to email address. For multiple addresses, send as an array of strings." }, "html": { "type": "string", "description": "The HTML version of the message." }, "text": { "type": "string", "description": "The plain text version of the message." }, "template": { "description": "The template value" }, "headers": { "type": "object", "description": "Custom headers to add to the email." }, "scheduled_at": { "type": "string", "description": "Schedule email to be sent later. The date should be in ISO 8601 format." }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "content": { "type": "string", "description": "Content of an attached file." }, "filename": { "type": "string", "description": "Name of attached file." }, "path": { "type": "string", "description": "Path where the attachment file is hosted" }, "content_type": { "type": "string", "description": "Optional content type for the attachment, if not set it will be derived from the filename property" }, "content_id": { "type": "string", "description": "Content ID for embedding inline images using cid references (e.g., cid:image001)." } } }, "description": "The attachments value" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the email tag. It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 256 characters." }, "value": { "type": "string", "description": "The value of the email tag.It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 256 characters." } } }, "description": "The tags value" }, "topic_id": { "type": "string", "description": "The topic ID to scope the email to. If the recipient is a contact and opted-in to the topic, the email is sent. If opted-out, the email is not sent. If the recipient is not a contact, the email is sent if the topic's default subscription is opt_in." } }, "required": [ "from", "to", "subject" ] }, "description": "Request body" } }, "required": [ "PCID" ] } ``` *** ## resend\_messaging\_post\_emails\_by\_email\_id\_cancel Cancel the schedule of the e-mail. **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | -------------------- | | `email_id` | string | Yes | — | The ID of the email. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "email_id": { "type": "string", "description": "The ID of the email." } }, "required": [ "PCID", "email_id" ] } ``` *** ## resend\_messaging\_post\_events Create an event **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------- | | `name` | string | Yes | — | The name of the event. Cannot start with the reserved `resend:` prefix. | | `schema` | object | No | — | An optional flat key/type map defining the event payload schema. Supported types are `string`, `number`, `boolean`, and `date`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The name of the event. Cannot start with the reserved `resend:` prefix." }, "schema": { "type": "object", "description": "An optional flat key/type map defining the event payload schema. Supported types are `string`, `number`, `boolean`, and `date`." } }, "required": [ "PCID", "name" ] } ``` *** ## resend\_messaging\_post\_events\_send Send an event **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ | | `contact_id` | string | No | — | The ID of the contact to associate with this event. Exactly one of `contact_id` or `email` must be provided. | | `email` | string | No | — | The email address to associate with this event. Exactly one of `contact_id` or `email` must be provided. | | `event` | string | Yes | — | The name of the event to send. | | `payload` | object | No | — | An optional payload of key/value pairs to include with the event. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "contact_id": { "type": "string", "description": "The ID of the contact to associate with this event. Exactly one of `contact_id` or `email` must be provided." }, "email": { "type": "string", "description": "The email address to associate with this event. Exactly one of `contact_id` or `email` must be provided." }, "event": { "type": "string", "description": "The name of the event to send." }, "payload": { "type": "object", "description": "An optional payload of key/value pairs to include with the event." } }, "required": [ "PCID", "event" ] } ``` *** ## resend\_messaging\_post\_templates Create a template **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `alias` | string | No | — | The alias of the template. | | `from` | string | No | — | Sender email address. To include a friendly name, use the format "Your Name \<[sender@domain.com](mailto:sender@domain.com)>". | | `html` | string | Yes | — | The HTML version of the template. | | `name` | string | Yes | — | The name of the template. | | `reply_to` | string\[] | No | — | Reply-to email addresses. | | `subject` | string | No | — | Email subject. | | `text` | string | No | — | The plain text version of the template. | | `variables` | object\[] | No | — | The variables value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "alias": { "type": "string", "description": "The alias of the template." }, "from": { "type": "string", "description": "Sender email address. To include a friendly name, use the format \"Your Name \"." }, "html": { "type": "string", "description": "The HTML version of the template." }, "name": { "type": "string", "description": "The name of the template." }, "reply_to": { "type": "array", "items": { "type": "string" }, "description": "Reply-to email addresses." }, "subject": { "type": "string", "description": "Email subject." }, "text": { "type": "string", "description": "The plain text version of the template." }, "variables": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the variable." }, "type": { "type": "string", "enum": [ "string", "number", "boolean", "object", "list" ], "description": "The type of the variable." }, "fallback_value": { "description": "The fallback value of the variable." } }, "required": [ "key", "type" ] }, "description": "The variables value" } }, "required": [ "PCID", "html", "name" ] } ``` *** ## resend\_messaging\_post\_templates\_by\_id\_duplicate Duplicate a template **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------- | | `id` | string | Yes | — | The Template ID or alias. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The Template ID or alias." } }, "required": [ "PCID", "id" ] } ``` *** ## resend\_messaging\_post\_templates\_by\_id\_publish Publish a template **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------- | | `id` | string | Yes | — | The Template ID or alias. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The Template ID or alias." } }, "required": [ "PCID", "id" ] } ```