Plunk integration (Communication, Marketing). Imported from open-connector.
https://next-api.useplunk.com/v1/send
| Param | Type | Required | Description |
|---|---|---|---|
| to | string | required | One or more Plunk recipients. |
| subject | string | optional | The email subject. Required when template is omitted. |
| body | string | optional | The HTML email body. Required when template is omitted. |
| template | string | optional | The Plunk template ID to use for this email. |
| from | string | optional | A Plunk sender as an email string or object. |
| subscribed | boolean | optional | Subscription state to apply to the recipient contact. |
| data | object | optional | Custom contact data or template variables accepted by Plunk. |
| headers | object | optional | Custom email headers keyed by header name. |
| reply | string | optional | The reply-to email address. |
/v1/track
| Param | Type | Required | Description |
|---|---|---|---|
| string | required | The contact email address. Plunk creates the contact if needed. | |
| event | string | required | The event name to track. |
| subscribed | boolean | optional | Subscription state to apply to the contact. |
| data | object | optional | Custom contact data or template variables accepted by Plunk. |
/v1/verify
| Param | Type | Required | Description |
|---|---|---|---|
| string | optional | The email address to verify. |
/contacts
| Param | Type | Required | Description |
|---|---|---|---|
| string | required | The contact email address. | |
| subscribed | boolean | optional | Whether the contact is subscribed. |
| data | object | optional | Custom contact data or template variables accepted by Plunk. |
/contacts
| Param | Type | Required | Description |
|---|---|---|---|
| limit | integer | optional | Maximum number of contacts to return. |
| cursor | string | optional | Pagination cursor returned by a previous list request. |
| search | string | optional | Case-insensitive substring search on contact email. |
/contacts/{contactId}
| Param | Type | Required | Description |
|---|---|---|---|
| contactId | string | required | The Plunk contact ID. |
/contacts/{contactId}
| Param | Type | Required | Description |
|---|---|---|---|
| contactId | string | required | The Plunk contact ID. |
| string | optional | Updated contact email address. | |
| subscribed | boolean | optional | Updated subscription state. |
| data | object | optional | Custom contact data or template variables accepted by Plunk. |
/contacts/{contactId}
| Param | Type | Required | Description |
|---|---|---|---|
| contactId | string | required | The Plunk contact ID. |