Sign in
messageChannels

Update One messageChannel

patch/messageChannels/{id}

Request

  • Base URL: https://twenty.mardu.systems/rest
  • URL: https://twenty.mardu.systems/rest/messageChannels/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Object id.

Query parameters

depth0 | 1

Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations

Request body

isSyncEnabledboolean

Is Sync Enabled

visibility'METADATA' | 'SUBJECT' | 'SHARE_EVERYTHING'

Visibility

handlestring

Handle

type'EMAIL' | 'SMS'

Channel Type

isContactAutoCreationEnabledboolean

Is Contact Auto Creation Enabled

contactAutoCreationPolicy'SENT_AND_RECEIVED' | 'SENT' | 'NONE'

Automatically create People records when receiving or sending emails

messageFolderImportPolicy'ALL_FOLDERS' | 'SELECTED_FOLDERS'

Message folder import policy

excludeNonProfessionalEmailsboolean

Exclude non professional emails

excludeGroupEmailsboolean

Exclude group emails

pendingGroupEmailsAction'GROUP_EMAILS_DELETION' | 'GROUP_EMAILS_IMPORT' | 'NONE'

Pending action for group emails

syncCursorstring

Last sync cursor

syncedAtstring date-time

Last sync date

syncStatus'ONGOING' | 'NOT_SYNCED' | 'ACTIVE' | 'FAILED_INSUFFICIENT_PERMISSIONS' | 'FAILED_UNKNOWN'

Sync status

syncStage'MESSAGE_LIST_FETCH_PENDING' | 'MESSAGE_LIST_FETCH_SCHEDULED' | 'MESSAGE_LIST_FETCH_ONGOING' | 'MESSAGES_IMPORT_PENDING' | 'MESSAGES_IMPORT_SCHEDULED' | 'MESSAGES_IMPORT_ONGOING' | 'FAILED' | 'PENDING_CONFIGURATION'

Sync stage

syncStageStartedAtstring date-time

Sync stage started at

throttleFailureCountinteger

Throttle Failure Count

connectedAccountIdstring uuid

Example request

{
  "visibility": "METADATA",
  "type": "EMAIL",
  "contactAutoCreationPolicy": "SENT_AND_RECEIVED",
  "messageFolderImportPolicy": "ALL_FOLDERS",
  "pendingGroupEmailsAction": "GROUP_EMAILS_DELETION",
  "syncStatus": "ONGOING",
  "syncStage": "MESSAGE_LIST_FETCH_PENDING",
  "connectedAccount": null
}

Response

Successful operation

Changes

No recorded changes to this operation across all 1 revision of this API.