Modify Email Templates

Select

SaaS

Customer Managed

This operation modifies the email templates

Path Parameters

• EmailTemplateId integer required

  Id of Email Template

application/json

Request Body

• name string

  Name of template

• description string

  Description of template

• emailTemplateId integer

  Id of template

• emailTemplateTypeId integer

  Id of template type

• ownerCompany object

  providerId integer

  Company id

• locale object

  localeId integer

  Locale id

• from object

  fullName string

  From name

  email string

  From email

• cc string

  cc addresses

• bcc string

  bcc addresses

• subject string

  Subject of mail

• emailBody string

  Body of mail

• isDefault boolean

  True if email template is default

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• emailTemplateEntity object

  emailTemplateId integer

  Id of email template

• error object

  errorMessage string

  Error message

  errorCode integer

  Error code

{
  "emailTemplateEntity": {
    "emailTemplateId": 0
  },
  "error": {
    "errorMessage": "string",
    "errorCode": 0
  }
}

{
  "emailTemplateEntity": {
    "emailTemplateId": 26
  },
  "error": {
    "errorMessage": "string",
    "errorCode": 0
  }
}

application/xml

• Schema
• Example (from schema)

---

Schema

• emailTemplateEntity object

  emailTemplateId integer
• error object

  errorMessage string

  errorCode integer

<root>
  <emailTemplateEntity>
    <emailTemplateId>0</emailTemplateId>
  </emailTemplateEntity>
  <error>
    <errorMessage>string</errorMessage>
    <errorCode>0</errorCode>
  </error>
</root>

PUT /emailtemplates/:emailtemplateid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

EmailTemplateId — path required

Body

• Default
• Example 1

---

{
  "name": "string",
  "description": "string",
  "emailTemplateId": 0,
  "emailTemplateTypeId": 0,
  "ownerCompany": {
    "providerId": 0
  },
  "locale": {
    "localeId": 0
  },
  "from": {
    "fullName": "string",
    "email": "string"
  },
  "cc": "string",
  "bcc": "string",
  "subject": "string",
  "emailBody": "string",
  "isDefault": true
}

Accept

application/jsonapplication/xml

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/EmailTemplates/:EmailTemplateId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "description": "string",
  "emailTemplateId": 0,
  "emailTemplateTypeId": 0,
  "ownerCompany": {
    "providerId": 0
  },
  "locale": {
    "localeId": 0
  },
  "from": {
    "fullName": "string",
    "email": "string"
  },
  "cc": "string",
  "bcc": "string",
  "subject": "string",
  "emailBody": "string",
  "isDefault": true
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/EmailTemplates/:EmailTemplateId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "description": "string",
  "emailTemplateId": 0,
  "emailTemplateTypeId": 0,
  "ownerCompany": {
    "providerId": 0
  },
  "locale": {
    "localeId": 0
  },
  "from": {
    "fullName": "string",
    "email": "string"
  },
  "cc": "string",
  "bcc": "string",
  "subject": "string",
  "emailBody": "string",
  "isDefault": true
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/EmailTemplates/:EmailTemplateId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "description": "string",
  "emailTemplateId": 0,
  "emailTemplateTypeId": 0,
  "ownerCompany": {
    "providerId": 0
  },
  "locale": {
    "localeId": 0
  },
  "from": {
    "fullName": "string",
    "email": "string"
  },
  "cc": "string",
  "bcc": "string",
  "subject": "string",
  "emailBody": "string",
  "isDefault": true
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/EmailTemplates/:EmailTemplateId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "description": "string",
  "emailTemplateId": 0,
  "emailTemplateTypeId": 0,
  "ownerCompany": {
    "providerId": 0
  },
  "locale": {
    "localeId": 0
  },
  "from": {
    "fullName": "string",
    "email": "string"
  },
  "cc": "string",
  "bcc": "string",
  "subject": "string",
  "emailBody": "string",
  "isDefault": true
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/EmailTemplates/:EmailTemplateId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "description": "string",
  "emailTemplateId": 0,
  "emailTemplateTypeId": 0,
  "ownerCompany": {
    "providerId": 0
  },
  "locale": {
    "localeId": 0
  },
  "from": {
    "fullName": "string",
    "email": "string"
  },
  "cc": "string",
  "bcc": "string",
  "subject": "string",
  "emailBody": "string",
  "isDefault": true
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/EmailTemplates/:EmailTemplateId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "description": "string",
  "emailTemplateId": 0,
  "emailTemplateTypeId": 0,
  "ownerCompany": {
    "providerId": 0
  },
  "locale": {
    "localeId": 0
  },
  "from": {
    "fullName": "string",
    "email": "string"
  },
  "cc": "string",
  "bcc": "string",
  "subject": "string",
  "emailBody": "string",
  "isDefault": true
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/EmailTemplates/:EmailTemplateId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "description": "string",
  "emailTemplateId": 0,
  "emailTemplateTypeId": 0,
  "ownerCompany": {
    "providerId": 0
  },
  "locale": {
    "localeId": 0
  },
  "from": {
    "fullName": "string",
    "email": "string"
  },
  "cc": "string",
  "bcc": "string",
  "subject": "string",
  "emailBody": "string",
  "isDefault": true
}'