← Tools Reference

Plunk

Plunk integration (Communication, Marketing). Imported from open-connector.

API key8 toolshttps://next-api.useplunk.com
POST
plunk_send_email
Send a transactional email through Plunk.

/v1/send

9 parameters
ParamTypeRequiredDescription
tostringrequiredOne or more Plunk recipients.
subjectstringoptionalThe email subject. Required when template is omitted.
bodystringoptionalThe HTML email body. Required when template is omitted.
templatestringoptionalThe Plunk template ID to use for this email.
fromstringoptionalA Plunk sender as an email string or object.
subscribedbooleanoptionalSubscription state to apply to the recipient contact.
dataobjectoptionalCustom contact data or template variables accepted by Plunk.
headersobjectoptionalCustom email headers keyed by header name.
replystringoptionalThe reply-to email address.
POST
plunk_track_event
Track an event for a Plunk contact.

/v1/track

4 parameters
ParamTypeRequiredDescription
emailstringrequiredThe contact email address. Plunk creates the contact if needed.
eventstringrequiredThe event name to track.
subscribedbooleanoptionalSubscription state to apply to the contact.
dataobjectoptionalCustom contact data or template variables accepted by Plunk.
POST
plunk_verify_email
Verify an email address with Plunk.

/v1/verify

1 parameter
ParamTypeRequiredDescription
emailstringoptionalThe email address to verify.
POST
plunk_create_contact
Create or update a Plunk contact by email.

/contacts

3 parameters
ParamTypeRequiredDescription
emailstringrequiredThe contact email address.
subscribedbooleanoptionalWhether the contact is subscribed.
dataobjectoptionalCustom contact data or template variables accepted by Plunk.
GET
plunk_list_contacts
List Plunk contacts with cursor pagination.

/contacts

3 parameters
ParamTypeRequiredDescription
limitintegeroptionalMaximum number of contacts to return.
cursorstringoptionalPagination cursor returned by a previous list request.
searchstringoptionalCase-insensitive substring search on contact email.
GET
plunk_get_contact
Get a single Plunk contact by ID.

/contacts/{contactId}

1 parameter
ParamTypeRequiredDescription
contactIdstringrequiredThe Plunk contact ID.
PATCH
plunk_update_contact
Update a Plunk contact by ID.

/contacts/{contactId}

4 parameters
ParamTypeRequiredDescription
contactIdstringrequiredThe Plunk contact ID.
emailstringoptionalUpdated contact email address.
subscribedbooleanoptionalUpdated subscription state.
dataobjectoptionalCustom contact data or template variables accepted by Plunk.
DELETE
plunk_delete_contact
Delete a Plunk contact by ID.

/contacts/{contactId}

1 parameter
ParamTypeRequiredDescription
contactIdstringrequiredThe Plunk contact ID.