POST `/communication/push-tokens`

Register a device push token (iOS APNs / Android FCM / Web Push / Desktop) for a specified user under the current tenant, for subsequent push notification sending. Duplicate token registration will automatically deactivate the old record, ensuring each token is unique and up-to-date in the database. References: ePrivacy Directive 2002/58/EC, CAN-SPAM Act.

Communication Service `bearerAuth` application/json

Request Body

Schema: dto.CreatePushTokenRequest

Field	Type	Required	Example	Constraints
`platform`	`string`	Yes	`ios`	enum: `ios`, `android`, `web`, `desktop`
`token`	`string`	Yes	`device_token_xxx`
`user_id`	`string`	Yes	`usr_abc123`
`device_id`	`string`	No	`iPhone15-001`

Responses

Status	Description	Schema
201	Registration successful, returns token details	`dto.PushTokenDataResponse`
400	Invalid request parameters	`dto.SimpleResponse`
401	Unauthenticated or invalid token	`dto.SimpleResponse`
403	Insufficient permissions to access this resource	`dto.SimpleResponse`
500	Internal server error	`dto.SimpleResponse`

Referenced Schemas

dto.PushTokenDataResponse

Field	Type	Required
`code`	`integer`	No
`data`	`dto.PushTokenResponse`	No
`message`	`string`	No
`timestamp`	`string`	No

dto.PushTokenResponse

Push token information

Field	Type	Required	Example
`created_at`	`string`	No	`2026-04-15T10:00:00Z`
`device_id`	`string`	No	`iPhone15-001`
`id`	`string`	No	`pt_abc123`
`is_active`	`boolean`	No	`True`
`platform`	`string`	No	`ios`
`user_id`	`string`	No	`usr_abc123`

dto.SimpleResponse

Field	Type	Required
`code`	`integer`	No
`message`	`string`	No
`timestamp`	`string`	No

Try this API in Scalar → Download OpenAPI spec (JSON) ↓

POST /communication/push-tokens