Get a channel type

get

/services/rest/connect/v1.4/channelTypes/{id}

Request

Path Parameters
Back to Top

Response

Default Response

Body ()
Root Schema : channelTypes
Type: object
The social channels tracked in contact records when storing social account user names and associating social monitor incidents to contacts.
Show Source
  • channelTypes-attributes
    The details about the channel type options.
  • Indicates whether the channel is available in the ChannelUsername collection. This attribute does not have a default value and is read-only.
  • The date and time when the channel type was created. This attribute is read-only.
  • Minimum Value: 1
    Maximum Value: 32767
    The position of the channel type in the list of channels.
  • Minimum Value: 1
    Maximum Value: 9223372036854776000
    The unique identifier of the channel type.
  • Maximum Length: 255
    The name used to look up the channel type.
  • Maximum Length: 80
    The name of the channel type in the language of the current interface. This attribute is read-only.
  • channelTypes-names
    The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.
  • The date and time when the channel type was last updated. This attribute is read-only.
Nested Schema : channelTypes-attributes
Type: object
The details about the channel type options.
Show Source
  • Indicates whether the channel is visible to contacts. This attribute does not have a default value.
  • Indicates whether it is an incoming channel. This attribute does not have a default value.
  • Indicates whether it is a monitoring channel. This attribute does not have a default value.
  • Indicates whether it is an outgoing channel. This attribute does not have a default value.
  • Indicates whether it is a subscription channel. This attribute does not have a default value.
Nested Schema : channelTypes-names
Type: object
The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.
Show Source
Nested Schema : namedIDs-channelTypes-names-language
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Back to Top

Examples

Use GET with the following syntax to retrieve data for a channel type object:

https://your_site_interface/services/rest/connect/version/channelTypes/channel_type_id

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/channelTypes/9

Response body example

{
  "id": 9,
  "lookupName": "Email",
  "attributes": {
    "contactVisibility": false,
    "incoming": true,
    "monitoring": false,
    "outgoing": true,
    "subscription": false
  },
  "contactVisibility": false,
  "displayOrder": 9,
  "name": "Email",
  "names": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/9/names"
      }
    ]
  },
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/9"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/9"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/channelTypes",
      "mediaType": "application/schema+json"
    }
  ]
}
Back to Top