BSV blockchainBSV blockchain

Acknowledge receipt of one or more messages

POST/acknowledgeMessage

Permanently deletes the specified messages from the database for the authenticated recipient. Used after a client has received and handled messages (e.g., after syncing or display).

Body application/json

messageIdsstring[]required

Array of message IDs to acknowledge and delete.

Response

Messages acknowledged (deleted) successfully.

status"success"

Missing or invalid input, or no matching messages found. Codes: ERR_MESSAGE_ID_REQUIRED, ERR_INVALID_MESSAGE_ID, ERR_INVALID_ACKNOWLEDGMENT

status"error"
codestring

Machine-readable error code (see specs/errors.md).

descriptionstring

Human-readable explanation.

Authentication required.

status"error"
codestring

Machine-readable error code (see specs/errors.md).

descriptionstring

Human-readable explanation.

Internal server error (ERR_INTERNAL_ERROR).

status"error"
codestring

Machine-readable error code (see specs/errors.md).

descriptionstring

Human-readable explanation.

Request
curl -X POST "https://{host}/acknowledgeMessage" \
  -H "Content-Type: application/json" \
  -H "x-bsv-auth-identity-key: <x-bsv-auth-identity-key>" \
  -d '{
  "messageIds": [
    "string"
  ]
}'
Response
{
  "status": "success"
}