Update a standard content

patch

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

Request

Path Parameters
Body ()
The preformed text or HTML content that can be sent to customers when responding to incidents, appended to responses by a business rule, or sent by an agent during a chat session.
Root Schema : standardContents
Type: object
The preformed text or HTML content that can be sent to customers when responding to incidents, appended to responses by a business rule, or sent by an agent during a chat session.
Show Source
Nested Schema : namedIDs-standardContents-adminVisibleInterfaces
Type: object
The named ID that can be included in a list.
Show Source
  • Minimum Value: 1
    Maximum Value: 9223372036854776000
    The unique identifier of the object. This is the key for the list entry.
  • Maximum Length: 255
    The name used to look up the object.
Nested Schema : standardContents-attributes
Type: object
The list of attributes for the standard content object.
Show Source
Nested Schema : standardContents-contentValues
Type: object
The standard content value with a data type and a formatted data value.
Show Source
Nested Schema : standardContents-folder
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
Nested Schema : standardContents-usage
Type: object
The usage information about the standard content.
Show Source
  • Indicates whether the content is used in a chat session. The default value is false.
  • Indicates whether the content is used in the URL of a chat session. The default value is false.
  • Indicates whether the content is used in an incident. The default value is false.
  • Indicates whether the content is used in a rule. The default value is false.
Nested Schema : namedIDs-standardContents-contentValues-contentType
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
Nested Schema : standardContents-folder-parents
Type: object
NamedID in which the ID is read-only. Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.
Show Source
Back to Top

Response

Default Response

Back to Top

Examples

Use the PATCH operation with the following syntax to partially update a standard content (standard text) object:

https://your_site_interface/services/rest/connect/version/standardContents/content_id

Include the data to be updated in the request body. Only the fields present in the request JSON data are updated. All other fields remain the same.

Request URI example

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

Request body example

{
"hotKey": "a"
}

Response example

The status 200 OK is returned. Then running the following query:

https://mysite.example.com/services/rest/connect/v1.4/standardContents/4?fields=id,name,hotKey

returns the following:

{
  "id": 4,
  "hotKey": "a",
  "name": "Return Address",
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/standardContents/4
       ?fields=id,name,hotKey"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/standardContents/4"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/standardContents",
      "mediaType": "application/schema+json"
    }
  ]
}

Note:

The hot key for Return Address is now a.
Back to Top