Send a chat message on a case
Changed onPosts 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 case must have passed Debitura approval and contract signing
- For a test or demo managed case, the managing partner may save case context during review
- 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.
Request
- Base URLhttps://collectionpartner-api.debitura.com
- URLhttps://collectionpartner-api.debitura.com/cases/{id}/chats
- AuthAPI key in header XApiKey
Path parameters
Headers
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
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)
Changes
- info
response property
roledeprecated (media type: text/plain) - info
response property
roledeprecated (media type: application/json) - info
response property
roledeprecated (media type: text/json)
- info
- breaking
for the
headerrequest parameterIdempotency-Key, the minLength was increased from0to1
- breaking