Update a conversation

patch

/crmRestApi/resources/11.13.18.05/conversations/{ConversationNumber}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
  • 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".
  • 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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Conversation References
Type: array
Title: Conversation References
Conversation references.
Show Source
Nested Schema : conversations-conversationReferences-item-patch-request
Type: object
Show Source
  • Title: Conversation ID
    The unique identifier of the conversation with which the business object is associated.
  • Title: Object ID
    The unique identifier of the business object associated with the conversation.
  • Title: Object Number
    Maximum Length: 255
    The alternate key identifier of the business object associated with the conversation.
  • Title: Object Type
    Maximum Length: 30
    The code indicating the type of the business object associated with the conversation, such as SVC_SERVICE_REQUESTS.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : conversations-item-response
Type: object
Show Source
Nested Schema : Conversation References
Type: array
Title: Conversation References
Conversation references.
Show Source
Nested Schema : conversations-conversationReferences-item-response
Type: object
Show Source
  • Title: Conversation ID
    The unique identifier of the conversation with which the business object is associated.
  • Title: Conversation Number
    Maximum Length: 30
    The alternate key identifier of the conversation with which the business object is associated.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the conversation reference.
  • Title: Creation Date
    Read Only: true
    The date when the conversation reference was created.
  • Title: Last Updated Date
    Read Only: true
    The date when the conversation reference was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the conversation reference.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login details of the user who last updated the conversation reference.
  • Links
  • Title: Object ID
    The unique identifier of the business object associated with the conversation.
  • Title: Object Number
    Maximum Length: 255
    The alternate key identifier of the business object associated with the conversation.
  • Title: Object Type
    Maximum Length: 30
    The code indicating the type of the business object associated with the conversation, such as SVC_SERVICE_REQUESTS.
  • Title: Object Type
    Read Only: true
    Maximum Length: 255
    The object type, such as Opportunity, Service Request, Activity, Sales Lead or Account.
  • Title: Reference ID
    Read Only: true
    The unique identifier of the conversation reference.
  • Title: Reference Number
    Maximum Length: 30
    The public unique identifier of the conversation reference.
Back to Top

Examples

The following example shows how to update a conversation by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl --location --request PATCH 'https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/conversations/CDRM_0000000005' \

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
    "ConversationStatusCd":"ORA_SVC_CLOSED"
}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "ConversationId": 300100547289438,
    "ConversationNumber": "CDRM_0000000005",
    "ConversationStatusCd": "ORA_SVC_CLOSED",
    "ConversationStatusCdMeaning": "Open",
    "ConversationTypeCd": "ORA_SVC_COLLABORATION",
    "ConversationSortDate": "2021-11-03T05:57:28.743+00:00",
    "CreatedBy": "MHoope",
    "CreationDate": "2021-09-22T07:02:29.215+00:00",
    "LastUpdateDate": "2021-11-03T05:59:58+00:00",
    "LastUpdateLogin": "CEFAD71A19DF5671E0532048F70AE6AE",
    "LastUpdatedBy": "SALES_ADMIN",
    "OriginatedConversationId": null,
    "OriginatedConversationNumber": null,
    "PrimaryMessageId": 300100547289437,
    "PrimaryMessageNumber": "CDRM_0000000005",
    "PrimaryMessageTitle": "Slack conversation started by Matt Hooper with #general",
    "StripeCd": "ORA_SVC_CRM",
    "BUOrgId": 204,
    "ConversationAlternateId": null,
    "links": [
...
}
Back to Top