Skip to main content
POST
/
v1
/
platform
/
phone-numbers
/
users
/
{user_id}
Request a Phone Number for a User
curl --request POST \
  --url https://api-sandbox.finogates.com/v1/platform/phone-numbers/users/{user_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number": "<string>",
  "iso_country": "<string>",
  "friendly_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

Assign a phone number to a user.

​
phone_number
string
required
​
iso_country
string
required
​
friendly_name
string | null

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.