XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

This API creates an integration endpoint. This operation could take up to 30 minutes. You can get endpoint creation status from endpoint detail API.

Request

{
  "AdminMail": "test@xomni.com",
  "ServiceName": "test",
  "ServiceTier": 0
}
HTTP Method Resource URI
POST https://{tenantName}.api.xomni.com/management/integration/endpoint

Request Body Description

Parameter Name Description Type Conditions
AdminMail Admin mail address. String
Required: Yes
ServiceName Name of the endpoint. String
Required: Yes
ServiceTier Type of service tier Number
Required: Yes

Possible values for service tier

Value Description
0 Developer Tier
1 Standart Tier
2 Premium Tier

Request Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.
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

The response does not contain any response entity if the status is successful.

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 POST operations. Possible response status codes are as listed below:

Status Code Description
201 (Created) Creating integration endpoint operation started.
400 (Bad Request) Invalid service tier.
400 (Bad Request) Integration endpoint is already created.
400 (Bad Request) Invalid service name.
409 (Conflict) Given service name already taken. Please specify different service name.