Subscriptions
SyncSubscription
Sync subscription
post/subscription/sync/{id}
Path parameters
idstring required
The channel ID.
Request body
subscriptionIdstring
<p>Synchronize/update an existing subscription</p>
endpointstring
<p>Web push subscription endpoint (for Web Push)</p>
publicKeystring
<p>Public key for web push notifications</p>
authSecretstring
<p>Auth secret for web push notifications</p>
apnsTokenstring
<p>Apple Push Notification Services token (for iOS Apps or Mac OS Safari)</p>
fcmTokenstring
<p>Google / Firebase Cloud Messaging token (for Android Apps)</p>
fcmIdstring
<p>Google / Firebase Cloud Messaging Sender ID (for Android Apps)</p>
emailAddressstring
<p>Email address (for Email channels). Can be changed by specifying the <code>uniqueIdentifier</code> field.</p>
emailOptInFormIdstring
<p>Email Opt In Form ID (for Email channels)</p>
emailOptInConfirmationIgnoredboolean
<p>Ignore double opt-in for email subscriptions topics - This lets you assign topics directly even if double opt-in is enabled</p>
emailConfirmedboolean
<p>Set to <code>true</code> to directly confirm email contact without having to click the confirmation link in the double-opt-in email</p>
phoneNumberstring
<p>Phone number (for SMS channels)</p>
phoneConfirmedboolean
<p>Set to <code>true</code> to directly confirm phone contact without having to click the confirmation link in the double-opt-in SMS</p>
customAttributesobject
<p>Object of custom attributes (Object Key = Attribute ID, Object value = Attribute value)</p>
topicsstring[]
<p>Array of Topic IDs</p>
addTopicsboolean
<p>Only add specified Topic IDs instead of overriding them</p>
isEditTopicsboolean
<p>Email only - Necessary to override Topic IDs instead of only adding them</p>
browserTypestring required
<p>Browser name (Chrome, Firefox, ... or your app's name e.g. CleverPush)</p>
browserVersionstring required
<p>Browser / Mobile SDK version</p>
appVersionstring required
<p>Mobile app version</p>
platformNamestring required
<p>OS name (e.g. Windows, iOS, Android, ...)</p>
platformVersionstring required
<p>OS version</p>
iosLiveActivityIdstring
<p>Live Activity ID (Only for iOS)</p>
iosLiveActivityTokenstring
<p>Live Activity Token (Only for iOS)</p>
uniqueIdentifierstring
<p>Field to identify existing subscription with. By default, a suitable field will be chosen automatically based on the channel type. Possible values: "customAttributes.user_id", "customAttributes.member_id", "subscriptionId".</p>
updateOnlyboolean
<p>If used it will not create new subscription it will only update existing subscription</p>
Response
Success (Updated):
idstring required
<p>The Subscription ID</p>
Changes
No recorded changes to this endpoint across all 1 revision of this API.