Skip to main content
POST
/
v1
/
platform
/
phone-numbers
/
users
/
{user_id}
/
devices
Register a Device for Notifications
curl --request POST \
  --url https://api-sandbox.finogates.com/v1/platform/phone-numbers/users/{user_id}/devices \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "token": "<string>",
  "provider": "fcm",
  "device_name": "<string>"
}
'
{
  "status_code": 123,
  "data": "<unknown>",
  "query_generated_time": 123
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
user_id
string
required

Body

application/json

Register (or refresh) a device's push-notification token.

​
token
string
required

Provider registration token.

Maximum string length: 512
​
device_type
enum<string>
required
Available options:
ios,
android,
web
​
provider
string
default:fcm
Maximum string length: 32
​
device_name
string | null
Maximum string length: 128

Response

Successful Response

Standard response wrapper for single-object responses and errors.

Generic over the payload type. A route that declares CommonResponse[SomeModel] gets the real data schema rendered in OpenAPI/Swagger; a bare CommonResponse leaves data untyped.

​
status_code
integer
required

HTTP status code for the response.

​
data
any
required

Payload or error details.

​
query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.