DEdebitura
Cases

Send a chat message

Changed on

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

Message Details:

  • The message is attributed to the team member identified by userId
  • The collection partner will receive an email notification about the new message
  • Messages appear in the case chat timeline in chronological order

Prerequisites:

  • The case must exist and belong to your account
  • The userId must be a valid user ID from GET /users belonging to your team

Use Case: Use this endpoint to communicate with collection partners about case progress, provide additional information, or respond to partner questions. Messages sent via this endpoint are equivalent to messages sent through the creditor portal chat.

post/cases/{id}/chats

Request

  • Base URL
    https://customer-api.debitura.com
  • URL
    https://customer-api.debitura.com/cases/{id}/chats
  • Auth
    • API key in header XApiKey
    • or HTTP bearer

Path parameters

idstring uuid required

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

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

Deprecated: kept as a number and never removed, but not extended — read roleLabel instead. Sender role: 0 = Partner, 1 = Creditor, 2 = ManagedByPartner.

roleLabelstring nullable

The sender role, readable. Always one of "Partner", "Creditor" or "Managed by partner" — these values are stable.

messagestring nullable
isSeenboolean

Changes

  • 4f9b5bb5655dRevision changes
    • info

      response property role deprecated (media type: text/plain)

    • info

      response property role deprecated (media type: application/json)

    • info

      response property role deprecated (media type: text/json)