Server path: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.
/unipile-email | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
unipile_email_create_calendar_event | Create an event |
unipile_email_create_draft | Create a draft |
unipile_email_delete_calendar_event | Delete an event |
unipile_email_delete_mail | Delete an email |
unipile_email_edit_calendar_event | Edit an event |
unipile_email_get_attachment | Retrieve an attachment from an email |
unipile_email_get_calendar | Retrieve a calendar |
unipile_email_get_calendar_event | Retrieve an event |
unipile_email_get_folder | Retrieve a folder |
unipile_email_get_mail | Retrieve an email |
unipile_email_list_calendar_events_by_calendar | Retrieve all events from a calendar |
unipile_email_list_calendars | List all calendars |
unipile_email_list_contacts | List email contacts |
unipile_email_list_folders | List all folders |
unipile_email_list_mails | List all emails |
unipile_email_send_mail | Send an email |
unipile_email_update_mail | Update an email |
unipile_email_create_calendar_event
Create an event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
account_id | string | Yes | — | The id of the account to use. |
calendar_id | string | Yes | — | The id of calendar receiving the event. |
attendees | object[] | Yes | — | The attendees value |
body | string | No | — | The body of the event. |
color | string | No | — | The color of the event. <br> Google Calendar: #7986CB, #33B679, #8E24AA, #E67C73, #F6BF26, #F4511E, #039BE5, #616161, #3F51B5, #0B8043, #D50000 |
conference | object | No | — | The conference value |
end | object | Yes | — | The end date and time of the event. |
guests_can_modify | boolean | No | — | If true, allow guests to modify the event. <br> Outlook Calendar: Not supported, this parameter will always be false. |
is_attendees_list_hidden | boolean | No | — | Is the attendees list hidden for attendees. |
location | string | No | — | The location of the event. |
notify | boolean | No | — | If true, send notifications about the event to invited attendees. <br> Outlook Calendar: Not supported, this parameter will always be true. |
recurrence | string[] | No | — | List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. |
start | object | Yes | — | The start date and time of the event. |
title | string | Yes | — | The title of the event. |
transparency | object | No | — | The transparency of the event. opaque does block time on the calendar and is equivalent to setting Show me as to Busy in the Calendar UI. transparent does not block time on the calendar and is equivalent to setting Show me as to Available in the Calendar UI. |
visibility | object | No | — | The visibility of the event. |
unipile_email_create_draft
Create a draft Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
account_id | string | Yes | — | A unique identifier. |
attachments | string[] | No | — | The attachments value |
bcc | object[] | No | — | The bcc value |
body | string | Yes | — | The body value |
cc | object[] | No | — | The cc value |
custom_headers | object[] | No | — | An array of custom headers to be added to the email. |
from | object | No | — | The from value |
reply_to | string | No | — | Either the Unipile ID or the provider ID of the email to reply to. |
subject | string | No | — | The subject value |
to | object[] | Yes | — | The to value |
tracking_options | object | No | — | Tracking Options |
unipile_email_delete_calendar_event
Delete an event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
calendar_id | string | Yes | — | The id of calendar receiving the event. |
event_id | string | Yes | — | The id of the event to edit. |
account_id | string | Yes | — | The id of the account to use. |
unipile_email_delete_mail
Delete an email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_id | string | Yes | — | The id of the email to be deleted. Either the Unipile id or the provider uid. |
account_id | string | No | — | The id of the account related to the email. Required when using the provider uid. |
unipile_email_edit_calendar_event
Edit an event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
account_id | string | Yes | — | The id of the account to use. |
event_id | string | Yes | — | The id of the event to edit. |
calendar_id | string | Yes | — | The id of calendar receiving the event. |
attendees | object[] | No | — | The attendees value |
body | string | No | — | The body of the event. |
color | string | No | — | The color of the event. <br> Google Calendar: #7986CB, #33B679, #8E24AA, #E67C73, #F6BF26, #F4511E, #039BE5, #616161, #3F51B5, #0B8043, #D50000 |
conference | object | No | — | The conference value |
end | object | No | — | The end date and time of the event. |
guests_can_modify | boolean | No | — | If true, allow guests to modify the event. <br> Outlook Calendar: Not supported, this parameter will always be false. |
is_attendees_list_hidden | boolean | No | — | Is the attendees list hidden for attendees. |
location | string | No | — | The location of the event. |
notify | boolean | No | — | If true, send notifications about the event update to invited attendees. |
recurrence | string[] | No | — | List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. |
start | object | No | — | The start date and time of the event. |
title | string | No | — | The title of the event. |
transparency | object | No | — | The transparency of the event. opaque does block time on the calendar and is equivalent to setting Show me as to Busy in the Calendar UI. transparent does not block time on the calendar and is equivalent to setting Show me as to Available in the Calendar UI. |
visibility | object | No | — | The visibility of the event. |
unipile_email_get_attachment
Retrieve an attachment from an email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_id | string | Yes | — | The id of the email to which the attachment is linked. Either the Unipile id or the provider uid. |
account_id | string | No | — | The id of the account related to the email. Required when using the provider uid. |
attachment_id | string | Yes | — | A unique identifier. The id of the attachment to be retrieved. |
unipile_email_get_calendar
Retrieve a calendar Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
account_id | string | Yes | — | The id of the account to use. |
calendar_id | string | Yes | — | The id of the wanted calendar. |
unipile_email_get_calendar_event
Retrieve an event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
account_id | string | Yes | — | The id of the account to use. |
event_id | string | Yes | — | The id of the wanted event. |
calendar_id | string | Yes | — | The id of calendar of the wanted event. |
unipile_email_get_folder
Retrieve a folder Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
folder_id | string | Yes | — | The id of the wanted folder. Either the Unipile id or the provider uid. |
account_id | string | No | — | The id of the account related to the folder. Required when using the provider uid. |
unipile_email_get_mail
Retrieve an email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_id | string | Yes | — | The id of the email to be retrieved. Either the Unipile id or the provider uid. |
account_id | string | No | — | The id of the account related to the email. Required when using the provider uid. |
include_headers | boolean | No | — | Include the email headers in the response. |
unipile_email_list_calendar_events_by_calendar
Retrieve all events from a calendar Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand_recurring | boolean | No | — | Filter events by type (single or occurence). |
event_type | string | No | — | Filter events by event type. This parameter accepts a comma-delimited list of event type. |
attendees | string | No | — | Filter events with attendees contained in this list. This parameter accepts a comma-delimited list of email addresses. |
updated_after | string | No | — | Filter events updated after this date. Preferred format: RFC3339 datetime (2026-02-27T17:07:49Z). |
updated_before | string | No | — | Filter events updated before this date. Preferred format: RFC3339 datetime (2026-02-27T17:07:49Z). |
busy | boolean | No | — | Filter for events with the status busy |
end | string | No | — | Filter events ending before this date. Preferred format: RFC3339 datetime (2026-02-27T17:07:49Z). |
start | string | No | — | Filter events starting after this date. Preferred format: RFC3339 datetime (2026-02-27T17:07:49Z). |
location | string | No | — | Filter for events matching the specified location. |
ical_uid | string | No | — | Filter for events matching the specified iCal UID. |
description | string | No | — | Filter for events matching the specified description. |
title | string | No | — | Filter for events matching the specified title. |
is_cancelled | boolean | No | — | Indicates if you want to retrieve the cancelled events. |
cursor | string | No | — | A cursor used for pagination. If supported by the provider, use next_cursor given by the previous page of the list, else use offset. |
offset | number | No | — | An offset used for pagination, if supported by the provider, else use cursor. |
limit | number | No | — | The limit of items to be returned. |
account_id | string | Yes | — | The id of the account to use. |
calendar_id | string | Yes | — | The id of the calendar related to events |
unipile_email_list_calendars
List all calendars Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | A cursor used for pagination. If supported by the provider, use next_cursor given by the previous page of the list, else use offset. |
offset | number | No | — | An offset used for pagination, if supported by the provider, else use cursor. |
limit | number | No | — | The limit of items to be returned. |
account_id | string | Yes | — | The id of the account to use. |
unipile_email_list_contacts
List email contacts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. |
limit | integer | No | — | A limit for the number of items returned in the response. The value can be set between 1 and 250. |
account_id | string | Yes | — | A filter to target items related to a certain account. |
unipile_email_list_folders
List all folders Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
account_id | string | No | — | A filter to target items related to a certain account. |
unipile_email_list_mails
List all emails Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
message_id | string | No | — | A filter to target items by message_id. |
thread_id | string | No | — | A filter to target items by thread identifier. |
meta_only | boolean | No | — | Speed up the response by only returning the email metadata, excluding the body and attachments metadata. |
include_headers | boolean | No | — | Include the email headers in the response. meta_only must be false. |
cursor | string | No | — | A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. |
before | string | No | — | A filter to target items created before the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ). |
after | string | No | — | A filter to target items created after the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ). |
limit | integer | No | — | A limit for the number of items returned in the response. The value can be set between 1 and 250. |
any_email | string | No | — | A filter to target items sent to or received from a comma-separated list of email addresses. |
to | string | No | — | A filter to target items related to a certain recipient, either in the to, cc or bcc field. |
from | string | No | — | A filter to target items related to a certain sender. |
exclude_folders | string | No | — | A filter to exclude items from a comma-separated list of folder provider_id ( ignored if folder parameter is used ). |
folder | string | No | — | A filter to target items related to a certain folder provider_id. |
account_id | string | Yes | — | A filter to target items related to a certain account. |
unipile_email_send_mail
Send an email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
account_id | string | Yes | — | A unique identifier. |
attachments | string[] | No | — | The attachments value |
bcc | object[] | No | — | The bcc value |
body | string | Yes | — | The body value |
cc | object[] | No | — | The cc value |
custom_headers | object[] | No | — | An array of custom headers to be added to the email. |
from | object | No | — | The from value |
reply_to | string | No | — | Either the Unipile ID or the provider ID of the email to reply to. |
subject | string | No | — | The subject value |
to | object[] | Yes | — | The to value |
tracking_options | object | No | — | Tracking Options |
unipile_email_update_mail
Update an email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_id | string | Yes | — | The id of the email to be updated. Either the Unipile id or the provider uid. |
account_id | string | No | — | The id of the account related to the email. Required when using the provider uid. |
categories | string[] | No | — | Outlook only: The categories to assign to the email. |
folders | string[] | No | — | The names of the folders to which the email should be moved. Outlook and IMAP accounts accept only one folder. If you provide a label value that does not already exist, a new label will be created with that value. |
unread | boolean | No | — | Indicates whether the email should be marked as unread. |

