Sign in
Conversations

Update conversation

Updates a conversation based on the unique conversation ID.

Any one of the following roles is required for this endpoint:

Legacy RoleEquivalent Permission Set Role
org.user.conversation.writeorg.permission.conversation.update

Note

This endpoint is subject to Object Rate Limiting, which limits how many updates a single user can make to a single conversation. To learn more, see Rate limiting.

Custom Attributes

Custom attributes are optional and allow you to specify custom key-value pairs.

Kustomer uses a naming convention for custom attributes to specify the field data type with a name suffix:

Naming Suffix

  • Num number or null
  • At date-time or null
  • Str string or null, length: [ 0 .. 1024 ] characters
  • Txt string or null, length: [ 0 .. 1024 ] characters
  • Bool boolean or null
  • Url string or null, format: uri
put/conversations/{id}

Request

  • Base URL: https://api.kustomerapp.com/v1
  • URL: https://api.kustomerapp.com/v1/conversations/{id}
  • Auth: httpBearer (a scheme the document does not define)

Path parameters

idstring required
Example:58228e05d4e96711004eccb7

Unique ID of the conversation.

Query parameters

replaceboolean
Example:true

Set to true to update the document. Otherwise, performs the same update as a PATCH request. Default value: false.

Request body

OR

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.