Apis::V4::PushNotification::DeviceToken API

post a new push notification device token

Parameters

Name	Description	type
access_token	JSON Web Token retrieved from the Sessions endpoint (you can also pass this into the Authorization header)
data	primary JSON API payload
data[attributes][token]	Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM, the device token equivalent is called the registration ID.	String
data[attributes][platform]	The platform of the device indicates which notification service should be used. Accepted values are APNS_SANDBOX and GCM	String

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo3MywiZXhwIjoxNzA0NDczMjI1LCJpYXQiOjE3MDQ0NzMwNDV9.HT629jBbGJkW7rDDUWP0d1K2jQKcg-5W6Rs1KpI_oMg
Host: example.org
Cookie:

Route

POST /apis/v4/push_notification_device_tokens

Body

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
X-MH-Session: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo3MywiZXhwIjoxNzA0NjQ1ODQ1LCJpYXQiOjE3MDQ0NzMwNDV9.Y3TG-rrnjMBlZBb-oGx4xUub6N2tt_4qkq-S4kOEQjU
Access-Control-Expose-Headers: X-MH-Session
ETag: W/"1f682a4e38d51cb7dd4e2fd8777b9d23"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: e62068bd-571d-4240-b1fe-e2f0d1030fbc
X-Runtime: 0.050905
Content-Length: 682

Status

Body

{
  "data": {
    "id": "11",
    "type": "push_notification_device_token",
    "attributes": {
      "token": "a new test token",
      "platform": "GCM",
      "updated_at": "2024-01-05T16:44:05Z",
      "created_at": "2024-01-05T16:44:05Z"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "73",
          "type": "user"
        }
      }
    }
  },
  "included": [
    {
      "id": "73",
      "type": "user",
      "attributes": {
        "timezone": null,
        "hidden_organizations": null,
        "organization_order": null,
        "terms_acceptance_date": null,
        "language": null,
        "mobile_language": null,
        "notification_settings": null,
        "pathway_stage_id": "",
        "onboarding_status": null,
        "username": "email_address_email_71@email.com",
        "created_at": "2024-01-05T16:44:05Z",
        "updated_at": "2024-01-05T16:44:05Z",
        "last_sign_in_at": null,
        "groups_feature": true
      }
    }
  ]
}