Comms API ReferencePush Notifications

Fetch a Push Credential

This operation fetches a single Push Notifications Credential using its ID.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

OR
AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

credentialIdstringRequired

Response

OK
idstringformat: "^comms_credential_[a-hjkmnpqrstv-z0-9]{26,34}"
A reference to Credential.
credentialTypeenum
The credential types available for PushNotifications.
Allowed values:
isDefaultbooleanDefaults to false

Use this Credential as the default for the Push Notification App for the given credentialType to send Push Notifications. If a Credential of the given type doesn’t already exist, this Credential automatically becomes the default.

appNamestring

The name of the app that this Credential is associated with. This should be the same value as the appName set when registering devices for the app with /PushNotifications/DeviceRegistrations

createdAtstringformat: "date-time"
updatedAtstringformat: "date-time"

Errors

400
Bad Request Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error