Skip to content

User Management API (v2)

Download OpenAPI description
Languages
Servers
Sandbox URL
https://api-ext-sboxmeta.partners.spotnana.com
Spotnana mock server
https://developer.spotnana.com/_mock/openapi/usersapi

Users

APIs to onboard and manage users.

Operations

Update managed travelers

Request

Security
Bearer
Path
userIdstring(uuid)required

Identifier for user.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Bodyapplication/jsonrequired
travelersArray of objects(ManagedTravelerWithUpdatableFields)required

Travelers to be updated.

travelers[].​userIdobject(UserId)required

User identifier

travelers[].​userId.​idstring(uuid)required
travelers[].​receiveEmailsboolean

Whether to receive emails of booking, flight notifications etc.

Default true
curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/users/4974a66b-7493-4f41-908c-58ba81093947/managed-travelers/update \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "travelers": [
      {
        "userId": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        },
        "receiveEmails": true
      }
    ]
  }'

Responses

OK

Response
No content

Remove managed travelers

Request

Security
Bearer
Path
userIdstring(uuid)required

Identifier for user.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Bodyapplication/jsonrequired
travelersArray of objects(UserId)required

Travelers to be removed.

travelers[].​idstring(uuid)required
curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/users/4974a66b-7493-4f41-908c-58ba81093947/managed-travelers/remove \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "travelers": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ]
  }'

Responses

OK

Response
No content

Get user's external ID

Request

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

Security
Bearer
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://api-ext-sboxmeta.partners.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" }

Roles

Operations