Sign in

v1

latestOpenAPI 3.1.12026-07-14355311.4 MB
Email

Update Email

Update an existing 'Email' record.

patch/Email/{id}

Request body

idstring

An ID.

namestring

A one-line string.

subjectstring

A one-line string.

fromNamestring nullable

A one-line string.

fromAddressstring nullable

A one-line string.

fromStringstring nullable

A one-line string.

replyToStringstring nullable

A one-line string.

replyToNamestring nullable

A one-line string.

replyToAddressstring nullable

A one-line string.

fromstring

A one-line string.

tostring

A one-line string.

ccstring nullable

A one-line string.

bccstring nullable

A one-line string.

replyTostring nullable

A one-line string.

personStringDatastring nullable

A one-line string.

isReadboolean
isNotReadboolean
isRepliedboolean
isNotRepliedboolean
isImportantboolean
inTrashboolean
inArchiveboolean
folderIdstring nullable
isUsersboolean
folderNamestring nullable

A foreign record name.

folderStringIdstring nullable
folderStringNamestring nullable

A foreign record name.

messageIdstring nullable

A one-line string.

messageIdInternalstring nullable

A one-line string.

emailAddressstring nullable

A one-line string.

fromEmailAddressIdstring nullable

An ID of the record of the EmailAddress type.

fromEmailAddressNamestring nullable

A foreign record name.

toEmailAddressesIdsstring[] nullable

IDs of records of the EmailAddress type.

toEmailAddressesNamesobject nullable

An {ID => record name} map.

ccEmailAddressesIdsstring[] nullable

IDs of records of the EmailAddress type.

ccEmailAddressesNamesobject nullable

An {ID => record name} map.

bccEmailAddressesIdsstring[] nullable

IDs of records of the EmailAddress type.

bccEmailAddressesNamesobject nullable

An {ID => record name} map.

replyToEmailAddressesIdsstring[] nullable

IDs of records of the EmailAddress type.

replyToEmailAddressesNamesobject nullable

An {ID => record name} map.

bodyPlainstring nullable

A multi-line text.

bodystring nullable

A multi-line text.

isHtmlboolean
status'Draft' | 'Sending' | 'Sent' | 'Archived' | 'Failed'
hasAttachmentboolean
parentIdstring nullable

A foreign record ID.

parentType'Account' | 'Lead' | 'Contact' | 'Opportunity' | 'Case' | 'CCompany' nullable

An entity type.

parentNamestring nullable

A foreign record name.

dateSentstring nullable

A timestamp in UTC.

deliveryDatestring nullable

A timestamp in UTC.

sendAtstring nullable

A timestamp in UTC.

isAutoReplyboolean
createdAtstring nullable

A timestamp in UTC.

modifiedAtstring nullable

A timestamp in UTC.

createdByIdstring nullable

An ID of the record of the User type.

createdByNamestring nullable

A foreign record name.

sentByIdstring nullable

An ID of the record of the User type.

sentByNamestring nullable

A foreign record name.

modifiedByIdstring nullable

An ID of the record of the User type.

modifiedByNamestring nullable

A foreign record name.

assignedUserIdstring nullable

An ID of the record of the User type.

assignedUserNamestring nullable

A foreign record name.

repliedIdstring nullable

An ID of the record of the Email type.

repliedNamestring nullable

A foreign record name.

repliesIdsstring[] nullable

IDs of records of the Email type.

repliesNamesobject nullable

An {ID => record name} map.

repliesColumnsobject nullable

An {ID => object} map. Relationship column values.

isSystemboolean
teamsIdsstring[] nullable

IDs of records of the Team type.

teamsNamesobject nullable

An {ID => record name} map.

usersIdsstring[] nullable

IDs of records of the User type.

usersNamesobject nullable

An {ID => record name} map.

usersColumnsobject nullable

An {ID => object} map. Relationship column values.

assignedUsersIdsstring[] nullable

IDs of records of the User type.

assignedUsersNamesobject nullable

An {ID => record name} map.

inboundEmailsIdsstring[] nullable

IDs of records of the InboundEmail type.

inboundEmailsNamesobject nullable

An {ID => record name} map.

emailAccountsIdsstring[] nullable

IDs of records of the EmailAccount type.

emailAccountsNamesobject nullable

An {ID => record name} map.

icsContentsstring nullable

A multi-line text.

icsEventUidstring nullable

A one-line string.

icsEventDateStartstring nullable

Specified if the 'icsEventDateStart' field is all-day.

icsEventDateStartDatestring date nullable
createdEventIdstring nullable

A foreign record ID.

createdEventTypestring nullable

An entity type.

createdEventNamestring nullable

A foreign record name.

groupFolderIdstring nullable

An ID of the record of the GroupEmailFolder type.

groupFolderNamestring nullable

A foreign record name.

groupStatusFolder'Archive' | 'Trash' nullable
accountIdstring nullable

An ID of the record of the Account type.

accountNamestring nullable

A foreign record name.

tasksIdsstring[] nullable

IDs of records of the Task type.

tasksNamesobject nullable

An {ID => record name} map.

tasksColumnsobject nullable

An {ID => object} map. Relationship column values.

Example request

{
  "dateSent": "2026-11-29 12:34:56",
  "deliveryDate": "2026-11-29 12:34:56",
  "sendAt": "2026-11-29 12:34:56",
  "createdAt": "2026-11-29 12:34:56",
  "modifiedAt": "2026-11-29 12:34:56",
  "icsEventDateStart": "2026-11-29 12:34:56"
}

Response

Success.

idstring

An ID.

namestring

A one-line string.

subjectstring

A one-line string.

fromNamestring nullable

A one-line string.

fromAddressstring nullable

A one-line string.

fromStringstring nullable

A one-line string.

replyToStringstring nullable

A one-line string.

replyToNamestring nullable

A one-line string.

replyToAddressstring nullable

A one-line string.

fromstring

A one-line string.

tostring

A one-line string.

ccstring nullable

A one-line string.

bccstring nullable

A one-line string.

replyTostring nullable

A one-line string.

personStringDatastring nullable

A one-line string.

isReadboolean
isNotReadboolean
isRepliedboolean
isNotRepliedboolean
isImportantboolean
inTrashboolean
inArchiveboolean
folderIdstring nullable
isUsersboolean
folderNamestring nullable

A foreign record name.

folderStringIdstring nullable
folderStringNamestring nullable

A foreign record name.

messageIdstring nullable

A one-line string.

messageIdInternalstring nullable

A one-line string.

emailAddressstring nullable

A one-line string.

fromEmailAddressIdstring nullable

An ID of the record of the EmailAddress type.

fromEmailAddressNamestring nullable

A foreign record name.

toEmailAddressesIdsstring[] nullable

IDs of records of the EmailAddress type.

toEmailAddressesNamesobject nullable

An {ID => record name} map.

ccEmailAddressesIdsstring[] nullable

IDs of records of the EmailAddress type.

ccEmailAddressesNamesobject nullable

An {ID => record name} map.

bccEmailAddressesIdsstring[] nullable

IDs of records of the EmailAddress type.

bccEmailAddressesNamesobject nullable

An {ID => record name} map.

replyToEmailAddressesIdsstring[] nullable

IDs of records of the EmailAddress type.

replyToEmailAddressesNamesobject nullable

An {ID => record name} map.

bodyPlainstring nullable

A multi-line text.

bodystring nullable

A multi-line text.

isHtmlboolean
status'Draft' | 'Sending' | 'Sent' | 'Archived' | 'Failed'
hasAttachmentboolean
parentIdstring nullable

A foreign record ID.

parentType'Account' | 'Lead' | 'Contact' | 'Opportunity' | 'Case' | 'CCompany' nullable

An entity type.

parentNamestring nullable

A foreign record name.

dateSentstring nullable

A timestamp in UTC.

deliveryDatestring nullable

A timestamp in UTC.

sendAtstring nullable

A timestamp in UTC.

isAutoReplyboolean
createdAtstring nullable

A timestamp in UTC.

modifiedAtstring nullable

A timestamp in UTC.

createdByIdstring nullable

An ID of the record of the User type.

createdByNamestring nullable

A foreign record name.

sentByIdstring nullable

An ID of the record of the User type.

sentByNamestring nullable

A foreign record name.

modifiedByIdstring nullable

An ID of the record of the User type.

modifiedByNamestring nullable

A foreign record name.

assignedUserIdstring nullable

An ID of the record of the User type.

assignedUserNamestring nullable

A foreign record name.

repliedIdstring nullable

An ID of the record of the Email type.

repliedNamestring nullable

A foreign record name.

repliesIdsstring[] nullable

IDs of records of the Email type.

repliesNamesobject nullable

An {ID => record name} map.

repliesColumnsobject nullable

An {ID => object} map. Relationship column values.

isSystemboolean
teamsIdsstring[] nullable

IDs of records of the Team type.

teamsNamesobject nullable

An {ID => record name} map.

usersIdsstring[] nullable

IDs of records of the User type.

usersNamesobject nullable

An {ID => record name} map.

usersColumnsobject nullable

An {ID => object} map. Relationship column values.

assignedUsersIdsstring[] nullable

IDs of records of the User type.

assignedUsersNamesobject nullable

An {ID => record name} map.

inboundEmailsIdsstring[] nullable

IDs of records of the InboundEmail type.

inboundEmailsNamesobject nullable

An {ID => record name} map.

emailAccountsIdsstring[] nullable

IDs of records of the EmailAccount type.

emailAccountsNamesobject nullable

An {ID => record name} map.

icsContentsstring nullable

A multi-line text.

icsEventUidstring nullable

A one-line string.

icsEventDateStartstring nullable

Specified if the 'icsEventDateStart' field is all-day.

icsEventDateStartDatestring date nullable
createdEventIdstring nullable

A foreign record ID.

createdEventTypestring nullable

An entity type.

createdEventNamestring nullable

A foreign record name.

groupFolderIdstring nullable

An ID of the record of the GroupEmailFolder type.

groupFolderNamestring nullable

A foreign record name.

groupStatusFolder'Archive' | 'Trash' nullable
accountIdstring nullable

An ID of the record of the Account type.

accountNamestring nullable

A foreign record name.

tasksIdsstring[] nullable

IDs of records of the Task type.

tasksNamesobject nullable

An {ID => record name} map.

tasksColumnsobject nullable

An {ID => object} map. Relationship column values.

Example response

{
  "dateSent": "2026-11-29 12:34:56",
  "deliveryDate": "2026-11-29 12:34:56",
  "sendAt": "2026-11-29 12:34:56",
  "createdAt": "2026-11-29 12:34:56",
  "modifiedAt": "2026-11-29 12:34:56",
  "icsEventDateStart": "2026-11-29 12:34:56"
}