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

Header

Name Required Type

accept

false

string

Path

Name Required Type

application-id

true

string

Response

Status Code Schema

200

ADMChannelResponse

GET

Header

Name Required Type

accept

false

string

Path

Name Required Type

application-id

true

string

Response

Status Code Schema

200

ADMChannelResponse

PUT

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

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

Response Schemas

Example ADMChannelResponse

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

Example MessageBody

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

Attributes

ADMChannelRequest

Attribute Type Description

ClientId

string

Client ID as gotten from Amazon

ClientSecret

string

Client secret as gotten from Amazon

Enabled

boolean

If the channel is enabled for sending messages.

ADMChannelResponse

Attribute Type Description

ApplicationId

string

CreationDate

string

When was this segment created

Enabled

boolean

If the channel is enabled for sending messages.

Id

string

Channel ID. Not used, only for backwards compatibility.

IsArchived

boolean

Is this channel archived

LastModifiedBy

string

Who last updated this entry

LastModifiedDate

string

Last date this was updated

Platform

string

Platform type. Will be "ADM"

Version

integer

Version of channel

MessageBody

Attribute Type Description

Message

string

The error message returned from the API.

RequestID

string

The unique message body ID.