Custom email templates

List custom email templates

List all of custom email templates

GEThttp://127.0.0.1:8888/api/custom_email_templates

Response

2004XX

OK

Body

application/json

itemsarray of object

A collection of custom email templates.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/custom_email_templates', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "name": "USER_CREATION",
      "from": "text",
      "subject": "text",
      "body": "text"
    }
  ]
}

Add custom email template

Create custom email template.

POSThttp://127.0.0.1:8888/api/custom_email_templates

Body

application/json

nameenum

Name of the email template:
Can be either:

• USER_CREATION: user creation notification.
• QUEUE_CALL_LOST: call queue call lost notification.
• QUEUE_SLA: call queue sla time reached notification.
• QUEUE_CALLBACK: call queue callback notification.
• QUEUE_CALLBACK_FAILED: call queue callback failed notification.
• VOICEMAIL_RECEIVED: received voicemail notification.
• CALL_REPORT_COMPLETED: call report completed notification.
• DISK_LOW: low disk notification.
• EMERGENCY_CALL: emergency call notification.
• LICENSE_LIMITED: license limited notification.
• RECHARGE: recharge notification.
• CONFERENCE_INVITATION: meeting invitation notification.

USER_CREATIONQUEUE_CALL_LOSTQUEUE_SLAQUEUE_CALLBACKQUEUE_CALLBACK_FAILEDVOICEMAIL_RECEIVEDCALL_REPORT_COMPLETEDDISK_LOWEMERGENCY_CALLLICENSE_LIMITEDRECHARGECONFERENCE_INVITATION

fromstring

Notification email from field.

subjectstring

Notification email subject field.

bodystring

Notification email body.

Response

2014XX

Created block code.

Body

application/json

idstring

The unique ID of the resource.

Example: "NzAwNTUxOTA5NzczMTQ4MTYw"

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/custom_email_templates', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve custom details of template

Get details of custom template by name.

GEThttp://127.0.0.1:8888/api/custom_email_templates/{name}

Path parameters

name*enum

Name of the email template:
Can be either:

• USER_CREATION: user creation notification.
• QUEUE_CALL_LOST: call queue call lost notification.
• QUEUE_SLA: call queue sla time reached notification.
• QUEUE_CALLBACK: call queue callback notification.
• QUEUE_CALLBACK_FAILED: call queue callback failed notification.
• VOICEMAIL_RECEIVED: received voicemail notification.
• CALL_REPORT_COMPLETED: call report completed notification.
• DISK_LOW: low disk notification.
• EMERGENCY_CALL: emergency call notification.
• LICENSE_LIMITED: license limited notification.
• RECHARGE: recharge notification.
• CONFERENCE_INVITATION: meeting invitation notification.

USER_CREATIONQUEUE_CALL_LOSTQUEUE_SLAQUEUE_CALLBACKQUEUE_CALLBACK_FAILEDVOICEMAIL_RECEIVEDCALL_REPORT_COMPLETEDDISK_LOWEMERGENCY_CALLLICENSE_LIMITEDRECHARGECONFERENCE_INVITATION

Response

2004XX

OK

Body

application/json

nameenum

Name of the email template:
Can be either:

• USER_CREATION: user creation notification.
• QUEUE_CALL_LOST: call queue call lost notification.
• QUEUE_SLA: call queue sla time reached notification.
• QUEUE_CALLBACK: call queue callback notification.
• QUEUE_CALLBACK_FAILED: call queue callback failed notification.
• VOICEMAIL_RECEIVED: received voicemail notification.
• CALL_REPORT_COMPLETED: call report completed notification.
• DISK_LOW: low disk notification.
• EMERGENCY_CALL: emergency call notification.
• LICENSE_LIMITED: license limited notification.
• RECHARGE: recharge notification.
• CONFERENCE_INVITATION: meeting invitation notification.

USER_CREATIONQUEUE_CALL_LOSTQUEUE_SLAQUEUE_CALLBACKQUEUE_CALLBACK_FAILEDVOICEMAIL_RECEIVEDCALL_REPORT_COMPLETEDDISK_LOWEMERGENCY_CALLLICENSE_LIMITEDRECHARGECONFERENCE_INVITATION

fromstring

Notification email from field.

subjectstring

Notification email subject field.

bodystring

Notification email body.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/custom_email_templates/{name}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "name": "USER_CREATION",
  "from": "text",
  "subject": "text",
  "body": "text"
}

Update custom email template

Update custom email template.

POSThttp://127.0.0.1:8888/api/custom_email_templates/{name}

Path parameters

name*enum

Name of the email template:
Can be either:

• USER_CREATION: user creation notification.
• QUEUE_CALL_LOST: call queue call lost notification.
• QUEUE_SLA: call queue sla time reached notification.
• QUEUE_CALLBACK: call queue callback notification.
• QUEUE_CALLBACK_FAILED: call queue callback failed notification.
• VOICEMAIL_RECEIVED: received voicemail notification.
• CALL_REPORT_COMPLETED: call report completed notification.
• DISK_LOW: low disk notification.
• EMERGENCY_CALL: emergency call notification.
• LICENSE_LIMITED: license limited notification.
• RECHARGE: recharge notification.
• CONFERENCE_INVITATION: meeting invitation notification.

USER_CREATIONQUEUE_CALL_LOSTQUEUE_SLAQUEUE_CALLBACKQUEUE_CALLBACK_FAILEDVOICEMAIL_RECEIVEDCALL_REPORT_COMPLETEDDISK_LOWEMERGENCY_CALLLICENSE_LIMITEDRECHARGECONFERENCE_INVITATION

Body

application/json

fromstring

Notification email from field.

subjectstring

Notification email subject field.

bodystring

Notification email body.

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/custom_email_templates/{name}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();