PUT

/v1/apps/{application-id}/channels/gcm

http://pinpoint.{region}.amazonaws.com/v1/apps/{application-id}/channels/gcm

Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.

Access Token Required: API Key

Path Parameters

application-idstringrequired

The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.

Body Params

GCMChannelRequestobjectrequired

Specifies the status and settings of the GCM channel for an application. This channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://pinpoint.{region}.amazonaws.com/v1/apps/{application-id}/channels/gcm' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}