Email providers

Update an SMTP/IMAP mailbox

Updates the credentials of an SMTP or Google IMAP mailbox, retests them and marks the mailbox as connected again. Masked passwords (********) are replaced by the stored values before the test.

patch/email-providers/{providerId}

Request

  • Base URL: https://api.emelia.io
  • URL: https://api.emelia.io/email-providers/{providerId}
  • Auth: API key in header Authorization

Path parameters

providerIdstring required

MongoDB ObjectId: 24 hexadecimal characters.

Example:6650f1a2b839d80011c5a0f1

Email provider id.

Request body

senderNamestring
senderEmailstring email required
senderPasswordstring

Used when smtp.password is empty.

emailType'GOOGLE' | 'OFFICE' | 'EXCHANGE' | 'SMTP' | 'GOOGLEIMAP' required
signaturestring
domainNamestring

Optional custom tracking domain to attach.

Response

Success.

successunknown
idstring

MongoDB ObjectId: 24 hexadecimal characters.

Example response

{
  "id": "6650f1a2b839d80011c5a0f1"
}

Changes

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