Skip to content

Subscription Status Casing Specification [DOC-571] #3394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 23, 2022
Merged

Subscription Status Casing Specification [DOC-571] #3394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/engage/profiles/csv-upload.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,8 @@ In the `email_subscription_status` and `sms_subscription_status` columns, set su
- `did-not-subscribe`: The user has provided their contact information but didn't actively subscribe or unsubscribe.
- **No subscription status (blank value)**: The user's profile exists in Segment, but they haven't explicitly provided their contact information, and no subscription information is available.

Engage accepts both uppercase and lowercase subscription status values.

> success ""
> Only contact users that subscribe to your communications. View [User Subscription States](/docs/engage/profiles/user-subscriptions/subscription-states/) to learn more.

Expand Down
5 changes: 4 additions & 1 deletion src/engage/profiles/user-subscriptions/set-user-subscriptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ These columns take the following values:
- `did-not-subscribe`; for users who have neither subscribed nor unsubscribed from your marketing campaigns
- Blank; for email addresses or phone numbers that Segment collected without the user explicitly providing them

> success ""
> Engage accepts both uppercase and lowercase subscription status values.

Refer to the [User Subscription States documentation](/docs/engage/profiles/user-subscriptions/subscription-states/) for detailed explanations of each subscription state.

<!--
Expand Down Expand Up @@ -61,7 +64,7 @@ When you update user subscriptions with Segment's Public API, however, you'll ge

### Format the Identify call payload

For Segment to process the subscription status request, your Identify call payload must include at least one object that contains an email address or phone number, its subscription type, and its subscription status.
For Segment to process the subscription status request, your Identify call payload must include at least one object that contains an email address or phone number, its subscription type, and its subscription status. Engage accepts both uppercase and lowercase subscription statuses in Identify calls.

The following example payload shows an Identify call with a `context` object, which you'll add to the Identify call to update user subscriptions. The `context` object contains a `messaging_subscriptions` array with two objects that update both SMS and email subscription statuses:

Expand Down