Register a push notification device

POST 
/api/v1/notifications/register-push-device

Registers an FCM device token for push notifications. Associates the token with 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

Request

Responses

200

Device registered successfully

Register the selected user’s actual device token; the displayed token is a placeholder.

Section ID: DOC-CP-notifications-api-registerPushDevice#example-notifications-registerPushDevice-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-registerPushDevice#example-cookbook-managed-agents-conversations-build-chat-assistant-05-request

Request example

{
  "fcmToken": "firebase-cloud-messaging-token",
  "platform": "PLATFORM_IOS",
  "deviceId": "device-unique-id"
}

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

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

Response example

{
  "success": true,
  "subscriberId": "example_123"
}

Illustrative response 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-registerPushDevice#example-cookbook-managed-agents-conversations-build-chat-assistant-json-06-response

Response example

{
  "subscriberId": "user_123",
  "success": true
}

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

Section	Stable reference
Register a push notification device	DOC-CP-notifications-api-registerPushDevice#overview
Request	DOC-CP-notifications-api-registerPushDevice#request
Responses	DOC-CP-notifications-api-registerPushDevice#responses