Conversations

Get conversation by external ID

Changed on

Retrieves a single conversation based on a unique external ID.

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

Legacy RoleEquivalent Permission Set Role
org.user.conversation.readorg.permission.conversation.read
get/conversations/externalId={externalId}

Request

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

Path parameters

externalIdstring required
Example:foobar

Unique external ID of the conversation

Response

OK

Changes

    • info

      api operation id GetConversationByExternalID removed and replaced with GetConversationByExternalId