Email Account Management APIs

Modify Email Account API

API to modify email account attributes on Titan Mail Cloud infra

post/partner/modifyEmailAccount

Request

  • Base URL: https://bll.titan.email
  • URL: https://bll.titan.email/partner/modifyEmailAccount
  • Auth: none declared

Request body

titanOrderIdnumber required

The unique order ID against each domain provisioned with Titan

titanAccountIdnumber

unique account id at Titan's end.

emailstring required

Email account which needs to be modified

namestring

The name of the customer only if there is a change in the name.

firstNamestring

The first name of the customer for whom the email address is being created.

lastNamestring

The last name of the customer for whom the email address is being created.

alternateEmailAddressstring

New alternate email address on which the customer can be contacted

passwordstring

New password that needs to be setup against the account

isAdminboolean

Specifies whether or not the user is an admin

purgeAtstring

In yyyy-MM-dd format. All the account data would be purged from Titan's system permanently on this date. Account is expected to be in the deleted state and not already purged. Domain should be active state. Must be set to a date from today up to a maximum of 30 days in the future. titanAccountId mandatorily to be passed while updating purgeAt. purgeAt date can only be increased for the account.

Example request

{
  "titanOrderId": 1,
  "titanAccountId": 123,
  "email": "info@xyz.com",
  "name": "Rose",
  "firstName": "James",
  "lastName": "Bond",
  "alternateEmailAddress": "rose@gmail.com",
  "password": "qwe123",
  "isAdmin": true,
  "purgeAt": "2020-02-20"
}

Response

OK

reqIDstring required

Example response

{
  "reqID": "server.req.id"
}

Changes

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