User Management API (v2)

Download OpenAPI description
Languages
Servers
Staging URL
https://apis.spotnana.com/
Spotnana mock server
https://developer.spotnana.com/_mock/openapi/usersapi/

Users

APIs to onboard and manage users.

Operations

Update notification preferences

Request

This endpoint updates notification preferences for a user.

Path
userIdstring(uuid)required

Identifier for user.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Bodyapplication/jsonrequired
preferencesArray of objects(NotificationPreferencePerType)
curl -i -X PUT \
  https://apis.spotnana.com/v2/users/4974a66b-7493-4f41-908c-58ba81093947/notification-preferences \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "preferences": [
      {
        "notificationType": "FLIGHT_NOTIFICATION",
        "emailPreference": {
          "enabled": true,
          "ccEmails": [
            "user@example.com"
          ]
        }
      }
    ]
  }'

Responses

OK

Response
No content

Get user travel arrangers

Request

Path
userIdstring(uuid)required

Identifier for user.

Example: 4974a66b-7493-4f41-908c-58ba81093947
curl -i -X GET \
  https://apis.spotnana.com/v2/users/4974a66b-7493-4f41-908c-58ba81093947/travel-arrangers \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
travelArrangersArray of objects(TravelArrangerBasicInfo)required
travelArrangers[].​nameobject(Name)

Full name containing first, middle, last (family) names, and suffix.

travelArrangers[].​emailstring(email)
Example: "example@email.com"
travelArrangers[].​phoneNumbersArray of objects(PhoneNumber)
travelArrangers[].​userIdobject(UserId)required

User identifier

travelArrangers[].​userId.​idstring(uuid)required
travelArrangers[].​statusstring(TravelerArrangerStatus)

Status of the traveler-arranger assignment.

Enum"PENDING""ACCEPTED""DENIED"
Response
application/json
{ "travelArrangers": [ {} ] }

Get user's external ID

Request

This endpoint gets user's external ID by user ID.

Path
userIdstring(uuid)required

Identifier for user.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Query
includeInactiveboolean

Include inactive users.

Default false
Example: includeInactive=true
curl -i -X GET \
  'https://apis.spotnana.com/v2/users/4974a66b-7493-4f41-908c-58ba81093947/external-id?includeInactive=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
externalIdstringrequired

A partner-assigned user identifier. This value must be unique for all travelers within a PNR.

Example: "user-1"
Response
application/json
{ "externalId": "user-1" }