API Documentation Download OpenAPI specification

Modify Mail Customer

POSThttps://bll.titan.email/partner/modifyMailCustomer
  • API to modify mail customer emailAddress, name and country.
  • API will change these properties for all mail orders associated with the titanOrderId mail customer.
  • Partner will receive MAIL_CUSTOMER_UPDATED notification whenever any of above 3 properties change

Note:

  • To change mail customer customerId call transferMailOrder API for every mail order associated with this mail customer.

Body

application/json
titanOrderIdnumberrequired
Example: 1
customerNamestringoptional

The new customer name

Example: Adam
customerEmailAddressstringoptional

The new customer email

Example: adma1231@gmail.com
customerCountrystringoptional

Should be the 2 letter ISO Code, country from which the customer is accessing partner website/making the purchase. Titan will use this to identify the localized pricing based on the location of the customer in cases where Titan mail is managing the billing.

Example: US
newCustomerIdstringoptional

The new customer Id.

Example: toBeUpdatedCustomerId

Responses

200OKapplication/json
reqIDstringrequired
Example: server.req.id
See General Errors for other errors that this API can return.
POST/partner/modifyMailCustomer
curl https://bll.titan.email/partner/modifyMailCustomer \
  --request POST \
  --header 'Authorization: API.Key' \
  --header 'Content-Type: application/json' \
  --data '{
  "titanOrderId": 1,
  "customerName": "Adam",
  "customerEmailAddress": "adma1231@gmail.com",
  "customerCountry": "US",
  "newCustomerId": "toBeUpdatedCustomerId"
}'
Response
{
  "reqID": "server.req.id"
}