Skip to main content

Unregister a push notification device

POST 

/api/v1/notifications/unregister-push-device

Removes an FCM device token from the user's subscriber profile.

The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized scoped domain action.

Use this in a guide: Keep push notifications attached to the signed-in user · Build a signed-in support chat that survives reconnects · Push registration and topic delivery

Request​

Responses​

Device unregistered successfully

Remove a device token previously registered for the selected user.​

Section ID: DOC-CP-notifications-api-unregisterPushDevice#example-notifications-unregisterPushDevice-request

Request example

{
"fcmToken": "REPLACE_WITH_DEVICE_FCM_TOKEN"
}

Guide request for Variant: bring the user back when a notification arrives. Replace example resource identifiers with your own authorized values.​

Section ID: DOC-CP-notifications-api-unregisterPushDevice#example-cookbook-managed-agents-conversations-build-chat-assistant-06-request

Request example

{
"fcmToken": "firebase-cloud-messaging-token"
}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.​

Section ID: DOC-CP-notifications-api-unregisterPushDevice#example-notifications-unregisterPushDevice-response

Response example

{
"subscriberId": "example_123",
"remainingCredentialCount": 1
}

Document ID: DOC-CP-notifications-api-unregisterPushDevice. Section identities and revisions.

SectionStable reference
Unregister a push notification deviceDOC-CP-notifications-api-unregisterPushDevice#overview
RequestDOC-CP-notifications-api-unregisterPushDevice#request
ResponsesDOC-CP-notifications-api-unregisterPushDevice#responses