Skip to main content
POST
/
v1
/
messages
Send a message to a debtor
curl --request POST \
  --url https://api.paytsoftware.com/v1/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "administration_id": "<string>",
  "message": {
    "body": "<string>",
    "subject": "<string>",
    "email": "<string>",
    "cc_email": "<string>",
    "bcc_email": "<string>",
    "attachments": [
      "<string>"
    ]
  },
  "debtor_number": "<string>",
  "debtor_identifier": "<string>",
  "invoice_number": "<string>",
  "invoice_identifier": "<string>",
  "credit_case_number": "<string>"
}
'
{
  "sender_type": "<string>",
  "subject": "<string>",
  "read_by_user": {
    "id": "<string>",
    "name": "<string>",
    "email_address": "<string>"
  },
  "administration_id": "<string>",
  "credit_case_id": "<string>",
  "debtor_id": "<string>",
  "id": "<string>",
  "invoice_id": "<string>",
  "sent_at": "2023-11-07T05:31:56Z",
  "received_at": "2023-11-07T05:31:56Z",
  "read_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "content": "<string>"
}

Authorizations

Authorization
string
header
required

OAuth2 access token or static API token. See Authorization for how to obtain one.

Body

Send a message to a debtor

administration_id
string
required

Administration identifier

message
object
required
debtor_number
string

Number of the debtor to send a message to

debtor_identifier
string

Identifier of the debtor to send a message to

invoice_number
string

Number of the invoice to send a message to

invoice_identifier
string

Identifier of the invoice to send a message to

credit_case_number
string

Number of the credit case to send a message to

Response

Message

CustomerApi_V1_MessageEntity model

sender_type
string
required

Sender type (creditor|debtor)

subject
string
required

Message subject

read_by_user
object
required

User who marked the message as read

administration_id
string
required

Owning administration identifier

credit_case_id
string
required

Associated credit_case identifier

debtor_id
string
required

Associated debtor identifier

id
string
required

Unique identifier

invoice_id
string
required

Associated invoice identifier

sent_at
string<date-time>
required

Timestamp at which the message was sent

received_at
string<date-time>
required

Timestamp at which the message was received

read_at
string<date-time>
required

Timestamp at which the message was first read (please note that for some mail clients this field is not filled when an email is read)

updated_at
string<date-time>
required

Timestamp at which the message was last updated

content
string

The content of the message (request with the 'fields' parameter)

Last modified on June 12, 2026