Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Attribute

Type

Required

Notes

title

Object

Yes

Provide the notification title in the project’s each language code in ISO 639-2 format. Max 140 characters per language.

body

Object

No

Provide the notification body in the project’s each language code in ISO 639-2 format. Max 140 characters per language.

deeplink

String

No

A deeplink that will open when the user clicks on the notification. For example:

myapp://activitiesList

Ask your implementation manager to get a list of available deeplinks for your app

segment

Integer

No

ID of the Segment to send the notification to (use the segment endpoint to see the available segment IDs)

limit

Integer

No

Set a maximum number of recipients chosen randomly

gc_user_ids

Array of strings

No

A list of GC user IDs you want the notification to be sent to

...

Code Block
languagejson
{
  "title": {
    "eng": "English title here",
    "fre": "Titre en français ici"
  },
  "body": {
    "eng": "The message content in English here",
    "fre": "Le contenu du message en français ici"
  },
  "deeplink": "myapp://activitiesList",
  "gc_user_ids": [
    "724d4eda-d7f7-4742-be15-6ca948aa11d3",
    "16481890-ff1e-4db5-ba39-45792e629f77",
    "61abe9b1-5699-4a77-9274-d0e6e67aa6d9"
  ]
}

...

Code Block
[
    {
        "id": 24,
        "title": {
            "eng": "Test 1"
        },
        "body": {
            "eng": "Body content"
        },
        "deeplink": null,
        "segment": null,
        "gc_user_ids": null,
        "status": "sent",
        "success_count": 1,
        "created_datetime": "2021-03-02T15:50:35",
        "created_by": "Yan Chouinard"
    },
    {
        "id": 25,
        "title": {
            "eng": "Test 2"
        },
        "body": {},
        "segment": 14,
        "deeplink": "myapp://activitiesList",
        "gc_user_ids": null,
        "status": "sent",
        "success_count": 1,
        "created_datetime": "2021-03-02T15:53:35",
        "created_by": "Yan Chouinard"
    },
    {
        "id": 28,
        "title": {
            "eng": "Test 3"
        },
        "body": {},
        "deeplink": null,
        "segment": null,
        "gc_user_ids": [
            "cbeca809-fdb9-484f-ad54-caecb5364173",
            "daf98ae5-68ce-43ee-8e23-c84c4cfb32bc",
            "476d161c-0491-441b-b7f3-d6bfba7de943"
        ],
        "status": "sent",
        "success_count": 2,
        "created_datetime": "2021-03-05T09:42:09",
        "created_by": "Yan Chouinard"
    }
]

...