Skip to main content
POST
/
comments
Create a comment
curl --request POST \
  --url https://api.leanpay.fr/v1/public/comments \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "Relance effectuée par @alice@example.com",
  "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "invoiceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "creditNoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Documentation Index

Fetch the complete documentation index at: https://docs.leanpay.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Body

application/json
​
text
string
required

Plain text content of the comment. Use @user@example.com to mention an active and notify them. The mentioned email must resolve to an active account for the client. Example: "Relance effectuée par @alice@example.com".

Example:

"Relance effectuée par @alice@example.com"

​
clientId
string<uuid>

ID of the client to attach the comment to

​
invoiceId
string<uuid>

ID of the invoice to attach the comment to (clientId is resolved from the invoice)

​
creditNoteId
string<uuid>

ID of the credit note to attach the comment to (clientId is resolved from the credit note)

Response

Created comment

​
id
string<uuid>