{"command":{"effect":"write","timeoutSeconds":30,"inputSchema":{"type":"object","description":"\nYou can update an existing conversation.\n\n{% admonition type=\"info\" name=\"Replying and other actions\" %}\nIf you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints.\n{% /admonition %}\n\n{% admonition type=\"info\" %}\n  This endpoint handles both **conversation updates** and **custom object associations**.\n\n  See _`update a conversation with an association to a custom object instance`_ in the request/response examples to see the custom object association format.\n{% /admonition %}\n\n{% admonition type=\"danger\" name=\"Breaking change: duplicate custom attribute names\" %}\nThe `PUT /conversations/{id}` endpoint now returns a `400 INVALID_PARAMETER` error when the request includes `custom_attributes` and your workspace contains multiple non-archived conversation custom attributes with the same name. Previously, the update would silently apply to a non-deterministic attribute. To resolve, rename or archive the duplicate attribute in your workspace settings, then retry the request.\n{% /admonition %}\n\n","properties":{"headers":{"type":"object","properties":{"Intercom-Version":{"$ref":"#/definitions/intercom_version","enum":["2.17"]}},"required":[],"additionalProperties":false},"path":{"type":"object","properties":{"conversation_id":{"type":"integer","examples":[123],"description":"The id of the conversation to target"}},"required":["conversation_id"],"additionalProperties":false},"query":{"type":"object","properties":{"display_as":{"type":"string","examples":["plaintext"],"description":"Set to plaintext to retrieve conversation messages in plain text. This affects both the body and subject fields. Inline links are rendered as `label (url)`, preserving the link URL alongside the visible text."}},"required":[],"additionalProperties":false},"body":{"$ref":"#/definitions/update_conversation_request","examples":[{"read":true,"title":"new conversation title","custom_attributes":{"issue_type":"Billing","priority":"High"}}]}},"required":["path"],"additionalProperties":false,"definitions":{"intercom_version":{"description":"Intercom API version.</br>If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.","type":"string","enum":["1.0","1.1","1.2","1.3","1.4","2.0","2.1","2.2","2.3","2.4","2.5","2.6","2.7","2.8","2.9","2.10","2.11","2.12","2.13","2.14","2.15","2.16","2.17"],"examples":["2.17"]},"update_conversation_request":{"title":"Update Conversation Request","type":"object","description":"Payload of the request to update a conversation","properties":{"read":{"type":"boolean","description":"Mark a conversation as read within Intercom.","examples":[true]},"title":{"type":"string","description":"The title given to the conversation","examples":["Conversation Title"]},"custom_attributes":{"$ref":"#/definitions/custom_attributes_request"},"company_id":{"type":"string","description":"The ID of the company that the conversation is associated with. The unique identifier for the company which is given by Intercom. Set to nil to remove company.","examples":["5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"]}}},"custom_attributes_request":{"title":"Custom Attributes (write)","type":"object","description":"The custom attributes which are set on this object, as key-value pairs. For relationship attributes the value should be a list of custom object instance models. Only attributes a caller may set should be sent here — attributes Intercom generates are returned in responses only.","additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"$ref":"#/definitions/datetime"},{"$ref":"#/definitions/custom_object_instance_list"}]},"examples":[{"paid_subscriber":true,"monthly_spend":155.5,"team_mates":9,"start_date_iso8601":"2023-03-04T09:46:14Z","end_date_timestamp":1677923174}]},"datetime":{"oneOf":[{"title":"string","type":"string","format":"date-time","description":"A date and time following the ISO8601 notation."},{"title":"integer","type":"integer","description":"A date and time as UNIX timestamp notation."}]},"custom_object_instance_list":{"title":"Custom Object Instances","type":"object","description":"The list of associated custom object instances for a given reference attribute on the parent object.","properties":{"type":{"type":"string","examples":["order.list"]},"instances":{"type":"array","description":"The list of associated custom object instances for a given reference attribute on the parent object.","items":{"$ref":"#/definitions/custom_object_instance"}}}},"custom_object_instance":{"title":"Custom Object Instance","type":["object","null"],"description":"A Custom Object Instance represents an instance of a custom object type. This allows you to create and set custom attributes to store data about your customers that is not already captured by Intercom. The parent object includes recommended default attributes and you can add your own custom attributes.","properties":{"id":{"type":"string","description":"The Intercom defined id representing the custom object instance.","examples":[16032025]},"external_id":{"type":"string","description":"The id you have defined for the custom object instance.","examples":["0001d1c1e65a7a19e9f59ae2"]},"external_created_at":{"type":["integer","null"],"format":"date-time","description":"The time when the Custom Object instance was created in the external system it originated from.","examples":[1571672154]},"external_updated_at":{"type":["integer","null"],"format":"date-time","description":"The time when the Custom Object instance was last updated in the external system it originated from.","examples":[1571672154]},"created_at":{"type":"integer","format":"date-time","description":"The time the attribute was created as a UTC Unix timestamp","examples":[1671028894]},"updated_at":{"type":"integer","format":"date-time","description":"The time the attribute was last updated as a UTC Unix timestamp","examples":[1671028894]},"type":{"type":"string","description":"The identifier of the custom object type that defines the structure of the custom object instance.","examples":["Order"]},"custom_attributes":{"type":"object","description":"The custom attributes you have set on the custom object instance.\n\nEach value is returned with the type of the attribute it is set on: a string, integer, number or boolean, or `null` when the attribute is unset. A list attribute returns the label of the selected option. A reference attribute returns an object holding the referenced records, under `contacts` for a contact reference, `conversations` for a conversation reference, or `instances` for a reference to another custom object type.","additionalProperties":{"anyOf":[{"type":["string","null"]},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"object"}]},"examples":[{"order_number":"ORDER-12345","total_amount":99.99}]}}}}},"name":"Update a conversation","id":"intercom.updateconversation","example":{"path":{"conversation_id":123}},"maxRequests":1,"summary":false}}