Sign in

db09d0fd5c94

latestOpenAPI 3.0.42026-08-134969330.3 KB
Cases

Send a chat message on a case

Posts a new chat message on a case, visible to both the collection partner and the creditor.

Message Details:

  • The message is attributed to the team member identified by userId
  • The creditor will receive an email notification about the new message
  • A task is created in the Debitura platform for the creditor to review the message
  • Messages appear in the case chat timeline in chronological order

Prerequisites:

  • The case must exist and be assigned to you as collection partner
  • The userId must be a valid user ID from GET /users belonging to your team

Use Case: Use this endpoint to communicate with creditors about case progress, request additional information, or provide status updates. Messages sent via this endpoint are equivalent to messages sent through the partner portal chat.

post/cases/{id}/chats

Path parameters

idstring uuid required

Headers

Idempotency-Keystring

Optional idempotency key (max 255 characters). If the same key is reused with an identical message body within 24 hours, the originally created chat message is returned instead of posting a duplicate. The key is scoped per partner, case, and message body — reusing it with a different body posts a new message rather than returning a conflict.

Request body

messagestring required

The chat message content to send.

userIdstring uuid nullable

ID of the team member sending this message. Must be a valid user ID from GET /users belonging to your team. Deprecated: use UserEmail instead. At least one of UserId or UserEmail must be provided.

userEmailstring email nullable

Email address of the team member sending this message. Must correspond to an active member of your team (same account as the API key). Preferred over UserId. At least one of UserEmail or UserId must be provided.

Example request

{
  "message": "Please provide the signed contract for this case.",
  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "userEmail": "john.doe@example.com"
}

Response

Chat message sent successfully (or duplicate idempotency key — existing response returned)

idstring uuid
dateCreatedstring date-time
dateUpdatedstring date-time nullable
role0 | 1 | 2
roleLabelstring nullable

Human-readable label for the role (e.g., "Partner", "Creditor", "Managed by partner"). Companion to Debitura.Web.ExternalApi.Contracts.V1.Chats.ChatDto.Role — always present when Role is set.

messagestring nullable
isSeenboolean