XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

This API provides a way to fetch a full list of all mail templates with skip and take parameters.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/catalog/mailtemplates?skip={skip}&take={take}

URI Parameters

Parameter Name Description Type Conditions
skip The number of items in the collection to skip before executing a select. Number
take The number of items in the collection to skip before executing a select. 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

{
    "Results": [
        {
            "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"
        },
        {
            "Id": 7,
            "Name": "559310cb-6ab8-b71470bba61e-b259-c41a6bf7ddab",
            "BodyTemplate": "236739e6-ef06-471d-bd2c-f00c9f80",
            "ItemTemplate": "6ab8-3b9a-c41a6bf7ddab-d478-a9952ff037de",
            "From": "43ba-6ab8-43a6-bb82-57b3fb8785dd",
            "FromDisplayName": null,
            "Subject": "d478-57b3fb8785dd-fcf8-0e727e373479-b71470bba61e"
        }
    ],
    "TotalCount": 5
}

Response Body Description

Parameter Name Description Type
TotalCount Total count of mail templates in the filtered collection without paging. Number
Results[0..N].Id The unique ID of the mail template. Number
Results[0..N].Name Name of the mail template. String
Results[0..N].BodyTemplate Body template of the mail template. String
Results[0..N].ItemTemplate Item template of the mail template. String
Results[0..N].From From e-mail address of the mail template. String
Results[0..N].FromDisplayName From display name of the mail template. String
Results[0..N].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.