Manage device registrations (APNS HTTP/2)
Add/remove/list channels in a single API call. If the add
and remove
query parameters are not present, the operation lists channels registered for the device.
Returns array with two elements:
- Array Element 0 - Integer – 1 or 0, where 1 is success, and 0 is error.
- Array Element 1 - String – Description of the success or error, if available. e.g "Modified Channels"
Path Parameters |
---|
sub_key string — REQUIREDYour app's subscribe key from Admin Portal. |
devices-apns2 string — REQUIREDID/Token of the device. Example:
|
Query Parameters |
---|
add stringList of channels for the device's inclusion in push registration. By using comma delimiters, multiple channels can be added e.g. (ch1, ch2, ch3), resulting in the addition of three channels. Example:
|
remove stringName of the channel for which the device will no longer recieve push notifications. By using comma delimiters, multiple channels can be added e.g. (ch1, ch2, ch3), resulting in the removal of three channels. Example:
|
environment string — REQUIREDPossible values: [ Environment of the mobile application. Example:
|
topic string — REQUIREDBundle ID of the mobile application. Example:
|
start stringStarting channel for pagination. Use the last channel from the previous page request. |
count integerNumber of channels to return for pagination. Max of 1000 tokens at a time. Defaults to 500. |
uuid string — REQUIREDA UTF-8 encoded string of up to 92 characters used to identify the client. Example:
|
auth stringString which is either the auth key (PAM v2) or a valid token (Access Manager) used to authorize the operation if access control is enabled. Example:
|
signature stringSignature used to verify that the request was signed with the secret key associated with the subscriber key. If Access Manager is enabled, either a valid authorization token or a signature are required. See Access Manager documentation for details on how to compute the signature. |
timestamp integerUnix epoch timestamp used as a nonce for signature computation. Must have no more than ± 60 seconds offset from NTP. Required if |
Responses | ||
---|---|---|
200 OK
| ||
400 Bad Request
|