Settings

Create sync settings for Imap account.

post/api/v1/settings/imap

Request

  • Base URL
    https://api.intheloop.io
  • Auth
    API key in header Authorization

Headers

Authorizationstring

Request body

idstring

Resource id

namestring

Resource name or title

revisionstring

Resource revision

clientIdstring

Resource client id

$typestring required
isEnabledboolean

Sync is enabled

isPausedboolean

Sync is paused (only contact sync is performed, no emails are imported)

importDayRangeinteger

Email import day range for the past

threadingMode'Recipient' | 'Standard'

Threading mode for syncing

emailstring

User's email

imapHoststring

User's imap server address

imapPortinteger required

User's imap server port

imapUsernamestring

User's imap username

imapPasswordstring

User's imap password (never gets sent out by the server, only set by client)

smtpHoststring

User's smtp server address

smtpPortinteger required

User's smtp server port

smtpUsernamestring

User's smtp username

smtpPasswordstring

User's smtp secret (never gets sent out by the server, only set by client)

sslRequiredboolean required

Is SSL required

Response

Created

idstring

Resource id

namestring

Resource name or title

revisionstring

Resource revision

clientIdstring

Resource client id

$typestring required
isEnabledboolean

Sync is enabled

isPausedboolean

Sync is paused (only contact sync is performed, no emails are imported)

importDayRangeinteger

Email import day range for the past

threadingMode'Recipient' | 'Standard'

Threading mode for syncing

emailstring

User's email

imapHoststring

User's imap server address

imapPortinteger required

User's imap server port

imapUsernamestring

User's imap username

imapPasswordstring

User's imap password (never gets sent out by the server, only set by client)

smtpHoststring

User's smtp server address

smtpPortinteger required

User's smtp server port

smtpUsernamestring

User's smtp username

smtpPasswordstring

User's smtp secret (never gets sent out by the server, only set by client)

sslRequiredboolean required

Is SSL required

Changes

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