Menu
Amazon Pinpoint
REST API Reference

ADM Channel

Use the ADM channel to send push notifications through the Amazon Device Messaging (ADM) service. With this channel, you can send notifications to apps running on Amazon devices, such as Kindle Fire tablets.

URI

/v1/apps/application-id/channels/adm

HTTP Methods

DELETE

Delete an ADM channel.

Header

Name Required Type

accept

false

string

Path

Name Required Type

application-id

true

string

Response

Status Code Schema

200

ADMChannelResponse

GET

Get an ADM channel.

Header

Name Required Type

accept

false

string

Path

Name Required Type

application-id

true

string

Response

Status Code Schema

200

ADMChannelResponse

PUT

Update an ADM channel.

Body

Name Required Type

ADMChannelRequest

true

ADMChannelRequest

Header

Name Required Type

accept

false

string

Path

Name Required Type

application-id

true

string

Response

Status Code Schema

200

ADMChannelResponse

Errors

Errors

Status Code Schema Error Type

400

MessageBody

BadRequestException

403

MessageBody

ForbiddenException

404

MessageBody

NotFoundException

405

MessageBody

MethodNotAllowedException

429

MessageBody

TooManyRequestsException

500

MessageBody

InternalServerErrorException

Schemas

Request Schemas

Example ADMChannelRequest

{ "ClientId": "string", "ClientSecret": "string", "Enabled": true }

Response Schemas

Example ADMChannelResponse

{ "ApplicationId": "string", "IsArchived": true, "Version": 0, "CreationDate": "string", "LastModifiedDate": "string", "LastModifiedBy": "string", "Id": "string", "Enabled": true, "HasCredential": true, "Platform": "string" }

Example MessageBody

{ "RequestID": "string", "Message": "string" }

Attributes

ADMChannelRequest

Attribute Type Description

ClientId

string

The Client ID that you obtained from the Amazon App Distribution Portal.

ClientSecret

string

The Client Secret that you obtained from the Amazon App Distribution Portal.

Enabled

boolean

Indicates whether or not the channel is enabled for sending messages.

ADMChannelResponse

Attribute Type Description

ApplicationId

string

The ID of the application to which the channel applies.

CreationDate

string

The date and time when this channel was created.

Enabled

boolean

Indicates whether or not the channel is enabled for sending messages.

HasCredential

boolean

Not used. Retained for backwards compatibility.

Id

string

(Deprecated) An identifier for the channel. Retained for backwards compatibility.

IsArchived

boolean

Indicates whether or not the channel is archived.

LastModifiedBy

string

The user who last updated this channel.

LastModifiedDate

string

The date and time when this channel was last modified.

Platform

string

The platform type. For this channel, the value is always "ADM."

Version

integer

The channel version.

MessageBody

Attribute Type Description

Message

string

The error message that's returned from the API.

RequestID

string

The unique message body ID.