v1

latestOpenAPI 3.0.0raw.githubusercontent.com2026-04-10958.9 KB
Partner notifications

Send a message to holders of a badge

Allows an authorized user to send a message to all holders of a badge that have opted-in to partner notifications

post/push/notification/badge

Headers

x-auth-domainstring required

The domain to authorize. Should match the domain specified in the body

x-auth-expiresstring required

The expiration time of the signature

x-auth-signaturestring required

The signature generating using domain owner private key

Request body

badgeCodestring

The badge identifier

subjectstring

Notification subject

messagestring

Notification message body

ctaUrlstring

Optional link the user can click for more information

imageUrlstring

Optional link to an image

Example request

{
  "badgeCode": "badge1",
  "subject": "My new subject",
  "message": "This is the message content",
  "ctaUrl": "https://unstoppabledomains.com",
  "imageUrl": "https://unstoppabledomains.com/logo.png",
  "sender": {
    "domain": "matt.x"
  }
}

Response

Notification successful