API Reference
  1. CircleHQ API Documentation
  2. Push Notifications

Send a push notification to one or more contacts

post
https://api.circlehq.co/api/v1/push/send
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
contactIds
array of strings
required

List of contact IDs to send the push notification to

contactIds*
string
required
length ≤ 255

Notification title

string
required
length ≤ 1024

Notification body text

string

URL of an image to display in the notification

string

Deep link URL or URI scheme to open when the notification is tapped

string

URL to open when the notification is clicked (web push and mobile)

data
object

Custom key-value data payload delivered alongside the notification

actions
array of objects
length ≤ 3

Up to 3 action buttons rendered with the notification. Web renders them natively; mobile SDKs render them from the data payload.

actions
Responses

Updated 2 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?