Skip to main content
GET
Notifications Content API

About this API

This API gives Astrozop publishers fresh content for daily push notifications. People like reading their horoscope every day, and a daily notification is a good way to bring them back to it. Instead of writing notification content yourself, you can pull it from this API each day. Each response contains content for all 12 sun signs, plus generic content for users whose birth date you don’t know. Every entry comes in two versions: one that includes the user’s first name, and one without it. You pick the right entry and version for each user, so you never need to send us your users’ personal data. To use this API, you need an Astrozop and your Bearer token, which you can find under Settings & Admin > API Tokens within the Gamezop Business Dashboard.

How to personalise notifications

For each user:
  1. Pick the sun sign. If you know the user’s birth date, find their sun sign in the table below and use that key from data.notification_text. If you don’t know their birth date, use generic.
  2. Pick the title and text. If you know the user’s first name, use title_with_name and text_with_name, and replace `username` (including both backticks) with the user’s first name. It appears exactly once in each of these strings. Otherwise, use title_without_name and text_without_name.
  3. Add the link. Send the user to cta_url when they tap the notification. If your notification has a button, use cta_text as its label.
For example, for a user named Priya born on 1995-04-02, use data.notification_text.aries.title_with_name and replace `username` with Priya. Use only the month and day of the birth date to find the sun sign:

Important notes

  • We only provide content in English.
  • Use only the user’s first name, not their full name, so that the text reads naturally.
  • New content is available every day from 00:00 UTC (05:30 IST). Pull it once a day after that, store it on your server, and send notifications from there. Don’t call the API once for each user.
  • image_url can be null. When it isn’t, the image has a 2:1 aspect ratio.
  • Each Property ID can make up to 10,000 requests per day. The daily quota resets at 00:00 UTC. Responses include x-rate-limit-limit, x-rate-limit-remaining and x-rate-limit-reset headers (401 errors don’t). Requests beyond the limit return 429, with a Retry-After header giving the number of seconds until the quota resets.
  • Every response includes an X-Request-Id header, and error responses repeat it as request_id. Quote it when you contact us about a failed request. You can also send your own X-Request-Id header (20 to 200 characters long), and we’ll use it instead of generating one.

Errors

Every error response has the same shape: success: false, version, request_id, and an error object with a code you can handle in your code and a human-readable message. Use error.code, not message, in your code, as messages may change.

API specification

Authorizations

Authorization
string
header
required

You can find the Bearer token for this API under Settings & Admin > API Tokens within the Gamezop Business Dashboard.

Response

HTTP 200 OK. Returns today's notification content. This example shows 2 sun signs and generic; real responses include all 12 sun signs and generic.

success
boolean

Boolean value that is true in successful responses.

version
string

Release version.

data
object