APNSMessage#collapse_id parameter rejected in create_campaign despite being documented

Describe the bug

When using Aws::Pinpoint::Client#create_campaign with an apns_message containing collapse_id, the SDK raises an ArgumentError even though collapse_id is a documented parameter for APNSMessage.

Regression Issue

Select this option if this issue appears to be a regression.

Expected Behavior

The collapse_id parameter should be accepted and passed to the Pinpoint API, which would then set the apns-collapse-id header when sending the push notification to APNs.

Current Behavior

The SDK raises an ArgumentError before making the API call:

unexpected value at params[:write_campaign_request][:message_configuration][:apns_message][:collapse_id] (ArgumentError)
    raise ArgumentError, error_messages(errors) unless errors.empty?

Reproduction Steps

require 'aws-sdk-pinpoint'

client = Aws::Pinpoint::Client.new(region: 'eu-west-1')

client.create_campaign({
  application_id: "my-app-id",
  write_campaign_request: {
    name: "test",
    segment_id: "my-segment-id",
    message_configuration: {
      apns_message: {
        action: "OPEN_APP",
        silent_push: false,
        raw_content: '{"aps":{"alert":{"title":"Test","body":"Test body"}}}',
        collapse_id: "offer-85817"
      }
    },
    schedule: {
      start_time: "IMMEDIATE"
    }
  }
})

Possible Solution

No response

Additional Information/Context

The CollapseId parameter is documented in the AWS Pinpoint API reference for APNSMessage
The collapse_id parameter works correctly with send_messages endpoint
The parameter is essential for iOS notification grouping/replacement via the apns-collapse-id APNs header

Gem name ('aws-sdk', 'aws-sdk-resources' or service gems like 'aws-sdk-s3') and its version

aws-sdk-pinpoint 1.116.0

Environment details (Version of Ruby, OS environment)

ruby 3.4.7, multiple env (osX, linux)

Hi! Thanks for submitting this issue. We'll investigate. Did the previous version of pinpoint accept the collapse_id param?

Hi! Thanks for submitting this issue. We'll investigate. Did the previous version of pinpoint accept the collapse_id param?

Hello, thanks.
We try only on the 103 and 116 release.

Hi! The CreateCampaign parameters come from the service team's model that we use to generate the SDK.

I noticed the Campaign documentation doesn't show CollapseId under APNSMessage, but the Message documentation does include it under APNSMessage. I'll cut a ticket to the service team to clarify this discrepancy and get back to you.

Hi! I received a response from the Pinpoint service regarding this issue:

This is expected behavior. Campaigns do not support the collapse_id parameter, whereas direct messages do. These are two different resources/APIs with different capabilities. Additionally, campaign functionality is on the path to deprecation, so this support will not be considered.
We recommend migrating to the newer messaging APIs: https://docs.aws.amazon.com/pinpoint/latest/userguide/migrate.html

Hope this clarifies the discrepancy. If you have additional questions about Pinpoint service
functionality, you can reach out to the service through via Contact Us in the migration guide linked above.

This issue has not received a response in 1 week. If you still think there is a problem, please leave a comment to avoid the issue from automatically closing.

@jterapin

Hello @jterapin,

That's more clear now !

Thanks for the investigation.

This issue is now closed. Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.

Navigation Menu

Repository navigation

APNSMessage#collapse_id parameter rejected in create_campaign despite being documented #3324

Describe the bug

Regression Issue

Expected Behavior

Current Behavior

Reproduction Steps

Possible Solution

Additional Information/Context

Gem name ('aws-sdk', 'aws-sdk-resources' or service gems like 'aws-sdk-s3') and its version

Environment details (Version of Ruby, OS environment)

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

APNSMessage#collapse_id parameter rejected in create_campaign despite being documented #3324

Description

Describe the bug

Regression Issue

Expected Behavior

Current Behavior

Reproduction Steps

Possible Solution

Additional Information/Context

Gem name ('aws-sdk', 'aws-sdk-resources' or service gems like 'aws-sdk-s3') and its version

Environment details (Version of Ruby, OS environment)

Activity

jterapin commented on Dec 11, 2025

Migoo commented on Dec 11, 2025

jterapin commented on Dec 11, 2025

jterapin commented on Dec 30, 2025

github-actions commented on Jan 10, 2026

Migoo commented on Jan 12, 2026

github-actions commented on Jan 12, 2026

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions