XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

This API provides a way to fetch a mail template by its ID.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/catalog/mailtemplate?id={id}

URI Parameters

Parameter Name Description Type Conditions
id The unique ID of the mail template. Number

Request Headers

Header Field Name Description
Accept
Includes minor version header.
Sample: application/vnd.xomni.api-v4-0, */*
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da

Response

{
    "Id": 3,
    "Name": "559310cb-fcf8-498d-a5cb-c41a6bf7ddab",
    "BodyTemplate": "236739e6-ef06-471d-bd2c-0e727e373479",
    "ItemTemplate": "fedbb74c-3b9a-43ba-b259-a9952ff037de",
    "From": "05ff3c57-6ab8-43a6-bb82-57b3fb8785dd",
    "FromDisplayName": null,
    "Subject": "f00c9f80-d478-4d12-a059-b71470bba61e"
}

Response Body Description

Parameter Name Description Type
Id The unique ID of the mail template. Number
Name Name of the mail template. String
BodyTemplate Body template of the mail template. String
ItemTemplate Item template of the mail template. String
From From e-mail address of the mail template. String
FromDisplayName From display name of the mail template. String
Subject Subject of the mail template. String

Response Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.

Status Codes

A successful operation returns status code 200 (OK) for GET operations. Possible response status codes are as listed below:

Status Code Description
404 (Not Found) No mail template has been found for the given mail template ID.