Skip to main content

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.

Server path: /unipile-email | Type: Application | PCID required: Yes

Tools

ToolDescription
unipile_email_create_calendar_eventCreate an event
unipile_email_create_draftCreate a draft
unipile_email_delete_calendar_eventDelete an event
unipile_email_delete_mailDelete an email
unipile_email_edit_calendar_eventEdit an event
unipile_email_get_attachmentRetrieve an attachment from an email
unipile_email_get_calendarRetrieve a calendar
unipile_email_get_calendar_eventRetrieve an event
unipile_email_get_folderRetrieve a folder
unipile_email_get_mailRetrieve an email
unipile_email_list_calendar_events_by_calendarRetrieve all events from a calendar
unipile_email_list_calendarsList all calendars
unipile_email_list_contactsList email contacts
unipile_email_list_foldersList all folders
unipile_email_list_mailsList all emails
unipile_email_send_mailSend an email
unipile_email_update_mailUpdate an email

unipile_email_create_calendar_event

Create an event Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringYesThe id of the account to use.
calendar_idstringYesThe id of calendar receiving the event.
attendeesobject[]YesThe attendees value
bodystringNoThe body of the event.
colorstringNoThe color of the event. <br> Google Calendar: #7986CB, #33B679, #8E24AA, #E67C73, #F6BF26, #F4511E, #039BE5, #616161, #3F51B5, #0B8043, #D50000
conferenceobjectNoThe conference value
endobjectYesThe end date and time of the event.
guests_can_modifybooleanNoIf true, allow guests to modify the event. <br> Outlook Calendar: Not supported, this parameter will always be false.
is_attendees_list_hiddenbooleanNoIs the attendees list hidden for attendees.
locationstringNoThe location of the event.
notifybooleanNoIf true, send notifications about the event to invited attendees. <br> Outlook Calendar: Not supported, this parameter will always be true.
recurrencestring[]NoList of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545.
startobjectYesThe start date and time of the event.
titlestringYesThe title of the event.
transparencyobjectNoThe 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.
visibilityobjectNoThe visibility of the event.

unipile_email_create_draft

Create a draft Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringYesA unique identifier.
attachmentsstring[]NoThe attachments value
bccobject[]NoThe bcc value
bodystringYesThe body value
ccobject[]NoThe cc value
custom_headersobject[]NoAn array of custom headers to be added to the email.
fromobjectNoThe from value
reply_tostringNoEither the Unipile ID or the provider ID of the email to reply to.
subjectstringNoThe subject value
toobject[]YesThe to value
tracking_optionsobjectNoTracking Options

unipile_email_delete_calendar_event

Delete an event Parameters:
ParameterTypeRequiredDefaultDescription
calendar_idstringYesThe id of calendar receiving the event.
event_idstringYesThe id of the event to edit.
account_idstringYesThe id of the account to use.

unipile_email_delete_mail

Delete an email Parameters:
ParameterTypeRequiredDefaultDescription
email_idstringYesThe id of the email to be deleted. Either the Unipile id or the provider uid.
account_idstringNoThe id of the account related to the email. Required when using the provider uid.

unipile_email_edit_calendar_event

Edit an event Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringYesThe id of the account to use.
event_idstringYesThe id of the event to edit.
calendar_idstringYesThe id of calendar receiving the event.
attendeesobject[]NoThe attendees value
bodystringNoThe body of the event.
colorstringNoThe color of the event. <br> Google Calendar: #7986CB, #33B679, #8E24AA, #E67C73, #F6BF26, #F4511E, #039BE5, #616161, #3F51B5, #0B8043, #D50000
conferenceobjectNoThe conference value
endobjectNoThe end date and time of the event.
guests_can_modifybooleanNoIf true, allow guests to modify the event. <br> Outlook Calendar: Not supported, this parameter will always be false.
is_attendees_list_hiddenbooleanNoIs the attendees list hidden for attendees.
locationstringNoThe location of the event.
notifybooleanNoIf true, send notifications about the event update to invited attendees.
recurrencestring[]NoList of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545.
startobjectNoThe start date and time of the event.
titlestringNoThe title of the event.
transparencyobjectNoThe 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.
visibilityobjectNoThe visibility of the event.

unipile_email_get_attachment

Retrieve an attachment from an email Parameters:
ParameterTypeRequiredDefaultDescription
email_idstringYesThe id of the email to which the attachment is linked. Either the Unipile id or the provider uid.
account_idstringNoThe id of the account related to the email. Required when using the provider uid.
attachment_idstringYesA unique identifier. The id of the attachment to be retrieved.

unipile_email_get_calendar

Retrieve a calendar Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringYesThe id of the account to use.
calendar_idstringYesThe id of the wanted calendar.

unipile_email_get_calendar_event

Retrieve an event Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringYesThe id of the account to use.
event_idstringYesThe id of the wanted event.
calendar_idstringYesThe id of calendar of the wanted event.

unipile_email_get_folder

Retrieve a folder Parameters:
ParameterTypeRequiredDefaultDescription
folder_idstringYesThe id of the wanted folder. Either the Unipile id or the provider uid.
account_idstringNoThe id of the account related to the folder. Required when using the provider uid.

unipile_email_get_mail

Retrieve an email Parameters:
ParameterTypeRequiredDefaultDescription
email_idstringYesThe id of the email to be retrieved. Either the Unipile id or the provider uid.
account_idstringNoThe id of the account related to the email. Required when using the provider uid.
include_headersbooleanNoInclude the email headers in the response.

unipile_email_list_calendar_events_by_calendar

Retrieve all events from a calendar Parameters:
ParameterTypeRequiredDefaultDescription
expand_recurringbooleanNoFilter events by type (single or occurence).
event_typestringNoFilter events by event type. This parameter accepts a comma-delimited list of event type.
attendeesstringNoFilter events with attendees contained in this list. This parameter accepts a comma-delimited list of email addresses.
updated_afterstringNoFilter events updated after this date. Preferred format: RFC3339 datetime (2026-02-27T17:07:49Z).
updated_beforestringNoFilter events updated before this date. Preferred format: RFC3339 datetime (2026-02-27T17:07:49Z).
busybooleanNoFilter for events with the status busy
endstringNoFilter events ending before this date. Preferred format: RFC3339 datetime (2026-02-27T17:07:49Z).
startstringNoFilter events starting after this date. Preferred format: RFC3339 datetime (2026-02-27T17:07:49Z).
locationstringNoFilter for events matching the specified location.
ical_uidstringNoFilter for events matching the specified iCal UID.
descriptionstringNoFilter for events matching the specified description.
titlestringNoFilter for events matching the specified title.
is_cancelledbooleanNoIndicates if you want to retrieve the cancelled events.
cursorstringNoA cursor used for pagination. If supported by the provider, use next_cursor given by the previous page of the list, else use offset.
offsetnumberNoAn offset used for pagination, if supported by the provider, else use cursor.
limitnumberNoThe limit of items to be returned.
account_idstringYesThe id of the account to use.
calendar_idstringYesThe id of the calendar related to events

unipile_email_list_calendars

List all calendars Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA cursor used for pagination. If supported by the provider, use next_cursor given by the previous page of the list, else use offset.
offsetnumberNoAn offset used for pagination, if supported by the provider, else use cursor.
limitnumberNoThe limit of items to be returned.
account_idstringYesThe id of the account to use.

unipile_email_list_contacts

List email contacts Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA 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.
limitintegerNoA limit for the number of items returned in the response. The value can be set between 1 and 250.
account_idstringYesA filter to target items related to a certain account.

unipile_email_list_folders

List all folders Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringNoA filter to target items related to a certain account.

unipile_email_list_mails

List all emails Parameters:
ParameterTypeRequiredDefaultDescription
message_idstringNoA filter to target items by message_id.
thread_idstringNoA filter to target items by thread identifier.
meta_onlybooleanNoSpeed up the response by only returning the email metadata, excluding the body and attachments metadata.
include_headersbooleanNoInclude the email headers in the response. meta_only must be false.
cursorstringNoA 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.
beforestringNoA filter to target items created before the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).
afterstringNoA filter to target items created after the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).
limitintegerNoA limit for the number of items returned in the response. The value can be set between 1 and 250.
any_emailstringNoA filter to target items sent to or received from a comma-separated list of email addresses.
tostringNoA filter to target items related to a certain recipient, either in the to, cc or bcc field.
fromstringNoA filter to target items related to a certain sender.
exclude_foldersstringNoA filter to exclude items from a comma-separated list of folder provider_id ( ignored if folder parameter is used ).
folderstringNoA filter to target items related to a certain folder provider_id.
account_idstringYesA filter to target items related to a certain account.

unipile_email_send_mail

Send an email Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringYesA unique identifier.
attachmentsstring[]NoThe attachments value
bccobject[]NoThe bcc value
bodystringYesThe body value
ccobject[]NoThe cc value
custom_headersobject[]NoAn array of custom headers to be added to the email.
fromobjectNoThe from value
reply_tostringNoEither the Unipile ID or the provider ID of the email to reply to.
subjectstringNoThe subject value
toobject[]YesThe to value
tracking_optionsobjectNoTracking Options

unipile_email_update_mail

Update an email Parameters:
ParameterTypeRequiredDefaultDescription
email_idstringYesThe id of the email to be updated. Either the Unipile id or the provider uid.
account_idstringNoThe id of the account related to the email. Required when using the provider uid.
categoriesstring[]NoOutlook only: The categories to assign to the email.
foldersstring[]NoThe 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.
unreadbooleanNoIndicates whether the email should be marked as unread.