Skip to Content
TillorManual
Notifications

Update External Notification

Access

Member of the organization with this permission:

  • notifications:external:write

An API key with scopes also needs the permission among its scopes.

PATCH
/orgs/{organizationId}/notifications/external/{id}

Updates the status, timestamps or content of an externally registered notification. Only notifications you registered yourself, unless you hold notifications:external:manage-others. Notifications sent by Tillor cannot be changed.

Authorization

ApiKeyAuth
headerx-api-key<token>

API key for authentication

Path Parameters

organizationId*string

The ID or slug of the organization

id*string
Length1 <= length

Request Body

application/json
  1. body
name?string
Length1 <= length <= 120
email?
status?string
Value in"SENT""FAILED""BOUNCED""COMPLAINED"
sentAt?string
Formatdate-time
readAt?|null
clickedAt?|null
errorMessage?|null

Response Body

OK

application/json
  1. response
Example Request
curl -X PATCH 'https://api.tillor.eu/orgs//notifications/external/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
null

Register External Notification POST

Registers a notification that your own system already sent (e.g. an email to a customer) so staff can see it in Tillor. Tillor does not send anything. Idempotent on externalSource + externalReference: repeating the call returns the existing notification. Read registered notifications with GET /notifications?source=EXTERNAL. Requires the notifications:external:write permission.

Delete External Notification DELETE

Permanently deletes an externally registered notification. Only notifications you registered yourself, unless you hold notifications:external:manage-others. Notifications sent by Tillor cannot be deleted.