Create an omnichannel property
post
/crmRestApi/resources/11.13.18.05/omniChannelProps
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AsyncFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the channel type supports asynchronous messaging. -
ChannelTypeCd: string
Maximum Length:
30
The channel type code available for omnichannel. -
MediaTypeCd: string
Maximum Length:
30
The media type code. -
NetworkTypeCd: string
Maximum Length:
30
The social network type such as Facebook, Twitter, or LinkedIn. This will be blank for channels like web, phone, or email. -
RealtimeFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the channel is a real time channel or not.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : omniChannelProps-item-response
Type:
Show Source
object
-
AsyncFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the channel type supports asynchronous messaging. -
ChannelPropId: integer
(int64)
Read Only:
true
The omnichannel property unique identifier. -
ChannelTypeCd: string
Maximum Length:
30
The channel type code available for omnichannel. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the omnichannel property. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the omnichannel property was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the omnichannel property was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the omnichannel property. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login of the user who last updated the omnichannel property. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MediaTypeCd: string
Maximum Length:
30
The media type code. -
NetworkTypeCd: string
Maximum Length:
30
The social network type such as Facebook, Twitter, or LinkedIn. This will be blank for channels like web, phone, or email. -
RealtimeFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the channel is a real time channel or not.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.