Custom email templates | PortSIP Knowledge Base

List custom email templates

get

List all of custom email templates

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/custom_email_templates' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

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

OK

Add custom email template

post

Create custom email template.

Authorizations

Body

namestring · enumoptional

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.
TRUNK_CONNECTED: trunk connected notification.
TRUNK_DISCONNECTED: trunk disconnected notification.

Available options:

fromstringoptional

Notification email from field.

subjectstringoptional

Notification email subject field.

bodystringoptional

Notification email body.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/custom_email_templates' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "USER_CREATION",
    "from": "text",
    "subject": "text",
    "body": "text"
  }'

201

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created block code.

Retrieve custom details of template

get

Get details of custom template by name.

Authorizations

Path parameters

namestring · enumrequired

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.
TRUNK_CONNECTED: trunk connected notification.
TRUNK_DISCONNECTED: trunk disconnected notification.

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/custom_email_templates/{name}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

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

OK

Update custom email template

post

Update custom email template.

Authorizations

Path parameters

namestring · enumrequired

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.
TRUNK_CONNECTED: trunk connected notification.
TRUNK_DISCONNECTED: trunk disconnected notification.

Available options:

Body

fromstringoptional

Notification email from field.

subjectstringoptional

Notification email subject field.

bodystringoptional

Notification email body.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/custom_email_templates/{name}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "from": "text",
    "subject": "text",
    "body": "text"
  }'

200

4XX

No body

OK