API Documentation Download OpenAPI specification

Modify Email Account API

POSThttps://bll.titan.email/partner/modifyEmailAccount

API to modify email account attributes on Titan Mail Cloud infra

Body

application/json
titanOrderIdnumberrequired

The unique order ID against each domain provisioned with Titan

Example: 1
titanAccountIdnumberoptional

unique account id at Titan's end.

Example: 123
emailstringrequired

Email account which needs to be modified

Example: info@xyz.com
namestringoptional

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

Example: Rose
firstNamestringoptional

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

Example: James
lastNamestringoptional

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

Example: Bond
alternateEmailAddressstringoptional

New alternate email address on which the customer can be contacted

Example: rose@gmail.com
passwordstringoptional

New password that needs to be setup against the account

Example: qwe123
isAdminbooleanoptional

Specifies whether or not the user is an admin

Example: true
purgeAtstringoptional

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: 2020-02-20

Responses

200OKapplication/json
reqIDstringrequired
Example: server.req.id
See General Errors for other errors that this API can return.
POST/partner/modifyEmailAccount
curl https://bll.titan.email/partner/modifyEmailAccount \
  --request POST \
  --header 'Authorization: API.Key' \
  --header 'Content-Type: application/json' \
  --data '{
  "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
{
  "reqID": "server.req.id"
}