Unipile: Update Email

Changes an email in the customer’s connected mailbox: mark it read or unread, or move it to another folder.

Tool ID: unipile_update_email

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'unipile_update_email',
  {
    "email_id": "jane.doe@example.com"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute unipile_update_email --input '{
  "email_id": "jane.doe@example.com"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "object": "EmailUpdated"
  }
}

Use deepline describe unipile_update_email --json for the latest machine-readable contract.

Input reference

Update an email.

Name	Type	Required	Default	Details
`payload.email_id`	`string`	Yes	—	The id of the email to be updated. Either the Unipile id or the provider uid.
`payload.account_id`	`string`	No	—	The id of the account related to the email. Required when using the provider uid.
`payload.unread`	`boolean`	No	—	Indicates whether the email should be marked as unread. Updates only the targeted email. If unread is supplied, all other parameters are ignored.
`payload.folders`	`array`	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. Updates the entire thread if the targeted email is part of a conversation
`payload.categories`	`array`	No	—	`Outlook only`: The categories to assign to the email.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	@todo Email has been updated.
`result.data.object`	`"EmailUpdated"`	Yes	—	Allowed: `EmailUpdated`.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation