🛎️Astrozop Notifications Content API

The Astrozop Notifications Content API provides daily notification content that Astrozop publishers can leverage to send push notifications to their users.

Why have an API for notification content?

This API is designed to make it easy for Astrozop publishers to engage their users with fresh, daily content. For example, users like reading their horoscope daily. If you want to send notifications daily, you need content for the notifications. This API is here to help you with fresh new content each day!

If you have your users' names and date of births, this API will automatically also personalize the notification content for your users. For example, the notification title and text could contain the user's name, or their sun sign (derived from the user's birth date).

This API ensures that you can keep your notifications relevant and engaging, without the need to manually create content every day, ultimately increasing user retention and interaction.

---

Making the request

API endpoint

GET https://api.astrozop.com/v1/notification-text

Headers

Name	Description
x-api-key*	Authentication API Key issued by our team to you. Please contact your Gamezop Account Manager for this.

Query parameters

Name	Description
property_id*	Your Astrozop Property ID
name	(Optional) First name of the user to who you'll send the push notification. This should be not exceed 30 characters in length.
birth_date	(Optional) Date of birth of the user to who you'll send the push notification. This should be formatted as YYYY-MM-DD

Understanding the response

The API provides a JSON response with a data object. This, in turn, contains a notification_content object with all the data you need to send notifications to your users.

Sample response

{
  "data": {
    "notification_content": {
      "cta_url": "https://www.astrozop.com/daily-horoscope",
      "cta_text": "READ NOW",
      "image_url": "https://static.astrozop.com/images/example.jpg",
      "title": "Best avoid travel today, Sparsh!",
      "text": "Travel plans? Think again. Today, Leos face the risk of..."
    }
  },
  "success": true,
  "version": "1.1.3"
}

Response body content

Description given below is for the contents of the data.notification_content object of the API response. Other parts are self-explanatory.

Key	Description
cta_url	The link to which you must send your user when they click on the notification. This link will always be a path on your Astrozop Unique Link (will contain your Property ID) so that ad revenue can be attributed to you.
cta_text	If you decide to have a button for your users in the notification, this the text to be used in the button.
image_url	If you want to include an image in the notification, you can use the image link provided here. Images will follow a 2:1 aspect ratio.
title	This is the title of the notification
text	This is the body of the notification

HTTP response codes

200: OK

You will receive data as a JSON response (example given above)

400: Bad Request

Here are the error messages you could receive, along with why you would receive them:

• User's name must be under 30 characters Occurs when the name URL param exceeds 30 characters.

• Birth date should be in YYYY-MM-DD format Occurs when the birth_date is not in the correct YYYY-MM-DD format.

• Invalid Property ID provided Occurs when the property_id is invalid.

• Property ID provided is not an Astrozop Property ID Occurs when the property_id is valid, but it's not an Astrozop Property ID

401: Unauthorized

Occurs when the x-api-key is incorrect or not provided.

429: Too Many Requests

Occurs when the rate limit has been exceeded.

Other notes

• We only provide content in English.

• Passing both name and birth_date is optional. If these parameters are provided, the content will be better personalized for the user. If they are not provided, the content will be generic.

• We recommend that you only pass the first name of the user in the name field. Avoid passing the full name, as using first name allows for better phrasing.

• Ideally, pull content from this API once each day and send it out to your users.