PUT

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

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

Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox 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

APNSVoipSandboxChannelRequestobjectrequired

Specifies the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.

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/apns_voip_sandbox' \
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}