User Management API (v2)

Download OpenAPI specification:Download

Users

APIs to onboard and manage users.

Create user

This endpoint is used to create user profiles in Spotnana. This is typically used by partner companies to onboard user profiles of their customer organizations.

SecurityBearer

Request

Request Body schema: application/json

required	object (UserPersonalInfo) User details.
	object (BusinessInfo) User business information.
persona required	string (Persona) Persona of the user Enum: "UNKNOWN_PERSONA" "EMPLOYEE" "GUEST" "PERSONAL" "RELATIVE" "ADHOC"
isActive	boolean a boolean flag to show if traveler is active.
	object (RelativeOf) Link to primary traveler
billingCurrency	string Preferred billing currency of the user
tier	string (Tier) Tier of User Enum: "BASIC" "SEAT1A"
externalId	string External id of this user.
	object (TravelPreferences) User's travel preferences
	object (MembershipInfo) User's travel preferences
	object (NotificationPreferences) Notification preferences of a user for different notification types.
	object (UserTravelArrangers) Deprecated Travel arrangers for a user.
	object (AdhocUserInfo) Basic information related to ad-hoc traveler profile.
	Array of objects (RoleConfig)

Responses

201

Created

401

Unauthorized

403

Forbidden

post/v2/users

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"personalInfo": {"addresses": [{"addressLines": ["Golden Gate Bridge"
],
"administrativeArea": "CA",
"administrativeAreaName": "California",
"description": "San Francisco Home",
"isDefault": true,
"languageCode": "en",
"locality": "San Francisco",
"locationCode": "LAX",
"organization": "Spotnana",
"postalCode": "94130",
"continentCode": "AF",
"recipients": ["string"
],
"regionCode": "US",
"regionName": "America",
"revision": 1,
"sortingCode": "Jamaica",
"sublocality": "string",
"timezone": "America/Los_Angeles",
"coordinates": {"latitude": 77.1025,
"longitude": 28.7041
}
}
],
"dob": {"iso8601": "2017-07-21"
},
"email": "example@email.com",
"emergencyContactInfo": {"address": {"addressLines": ["Golden Gate Bridge"
],
"administrativeArea": "CA",
"administrativeAreaName": "California",
"description": "San Francisco Home",
"isDefault": true,
"languageCode": "en",
"locality": "San Francisco",
"locationCode": "LAX",
"organization": "Spotnana",
"postalCode": "94130",
"continentCode": "AF",
"recipients": ["string"
],
"regionCode": "US",
"regionName": "America",
"revision": 1,
"sortingCode": "Jamaica",
"sublocality": "string",
"timezone": "America/Los_Angeles",
"coordinates": {"latitude": 77.1025,
"longitude": 28.7041
}
},
"designation": "MANAGER",
"email": "emergency-contact@email.com",
"name": {"family1": "Gandas",
"family2": "FamilyTwo",
"given": "Vichitr",
"middle": "Kumar",
"suffix": "SR",
"preferred": "Don"
},
"phoneNumber": {"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
},
"userOrgId": {"organizationAgencyId": {"id": "string"
},
"organizationId": {"id": "string"
},
"userId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"tmcInfo": {"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"primaryServiceProviderTmc": {"tmcId": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
}
},
"secondaryServiceProviderTmcs": [{"tmcId": {"id": null
},
"supplier": "SABRE",
"travelType": "AIR"
}
],
"partnerTmcId": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
}
},
"tmcBasicInfo": {"contractingTmc": {"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"name": "string",
"logo": {"data": "6935813e12584abda0e43d71cd2ea260",
"dimensions": {"height": null,
"width": null
},
"url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
}
},
"bookingTmc": {"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"name": "string",
"logo": {"data": "6935813e12584abda0e43d71cd2ea260",
"dimensions": {"height": null,
"width": null
},
"url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
}
}
}
}
},
"gender": "FEMALE",
"identityDocs": [{"passport": {"docId": "PASSPORTID",
"expiryDate": {"iso8601": "2017-07-21"
},
"issueCountry": "IN",
"issuedDate": {"iso8601": "2017-07-21"
},
"nationalityCountry": "IN",
"type": "REGULAR"
}
},
{"ktn": {"number": "123456",
"issueCountry": "US"
}
}
],
"name": {"family1": "Gandas",
"family2": "FamilyTwo",
"given": "Vichitr",
"middle": "Kumar",
"suffix": "SR",
"preferred": "Don"
},
"phoneNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"profilePicture": {"data": "6935813e12584abda0e43d71cd2ea260",
"dimensions": {"height": 120,
"width": 240
},
"url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
},
"nationality": "Indian",
"title": "MR",
"preferredLanguage": "en-US",
"preferredPronoun": "SHE_HER_HERS",
"travelerName": {"family1": "Gandas",
"family2": "FamilyTwo",
"given": "Vichitr",
"middle": "Kumar",
"suffix": "SR",
"preferred": "Don"
}
},
"businessInfo": {"departmentRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"designation": "MANAGER",
"email": "user@business.com",
"employeeId": "101",
"gradeRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"legalEntityRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"managerRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"officeRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"organizationRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"phoneNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"costCenterRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"countryCode": "USA",
"workerType": "EMPLOYEE",
"accountingCode": "123",
"companySpecifiedAttributes": [{"fixedColumnName": "contingentType",
"value": "FSTV"
}
],
"designatedApproverRefs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
],
"authorizerEmail": "example@email.com"
},
"persona": "EMPLOYEE",
"isActive": true,
"relativeOf": {"userRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"relation": "SPOUSE"
},
"billingCurrency": "INR",
"tier": "SEAT1A",
"externalId": "string",
"travelPreferences": {"preferences": {"airPref": {"airlinePrefs": [{"airlines": ["Indigo"
],
"flightType": "DOMESTIC"
}
],
"alliancePref": {"alliances": ["STAR_ALLIANCE"
]
},
"farePref": {"fareTypes": ["CHANGEABLE"
]
},
"homeAirport": "NEW YORK",
"mealPref": {"exclMealPrefs": ["VGML"
],
"inclMealPrefs": ["VGML"
],
"specialMealDescription": "Veg only meal"
},
"numStopPref": {"numOfStops": 34
},
"seatAmenityPref": {"seatAmenityTypes": ["WIFI"
]
},
"seatLocationPrefs": [{"cabins": ["FIRST"
],
"isBulkHeadPref": false,
"maxFlightDurationInHours": 3,
"position": "WINDOW"
}
],
"preferredAirports": [{"airportName": "San Francisco International Airport",
"airportCode": "SFO",
"label": "HOME"
}
]
},
"preferredCurrency": "USD",
"railCards": [{"cardNumber": "string",
"expiryDate": {"iso8601": "2017-07-21"
},
"name": "Veterans Railcard",
"spotnanaCode": "VET",
"vendor": "ATOC"
}
],
"railPref": {"preferredRailStations": [{"stationName": "Chicago Union Station",
"stationCode": "CHI",
"cityName": "Chicago",
"countryCode": "string",
"label": "HOME"
}
],
"seatPreference": {"hasAccessibility": false,
"seatTypes": ["NORMAL"
],
"seatLocations": ["AISLE"
],
"deckLevels": ["UPPER_DECK"
],
"seatDirections": ["FORWARD"
]
},
"travelClasses": ["FIRST"
],
"coachPreferences": ["NON_SMOKING"
],
"conditionalRates": ["AAA"
]
},
"carPref": {"vendors": [{"code": "ZE",
"name": "HERTZ",
"isPresentInPreferredVendors": true
}
],
"carTypes": ["ECONOMY"
],
"engineTypes": ["PETROL"
],
"transmissionTypes": ["AUTOMATIC"
],
"conditionalRates": ["AAA"
]
},
"hotelPref": {"hotelParentChains": [{"chainCode": "EM",
"chainName": "Mariott"
}
],
"hotelBrands": [{"brandCode": "HY",
"brandName": "Global Hytt Corp."
}
],
"hotelAmenityTypes": ["PARKING"
],
"roomPreference": {"isMobilityAccessible": false,
"bedCount": "ONE_BED",
"roomType": "SMOKING",
"mostImportantFact": "BED_COUNT",
"roomLocation": "HIGH_FLOOR",
"pillowType": "FOAM",
"roomAmenityPrefs": ["EXTRA_TOWELS"
]
},
"conditionalRates": ["AAA"
]
}
}
},
"membershipInfo": {"membershipInfos": [{"appliedTo": ["TAJ"
],
"id": "firstId",
"issuedBy": "firstIssuedBy",
"type": "AIR"
}
]
},
"notificationPreferences": {"preferences": [{"notificationType": "FLIGHT_NOTIFICATION",
"emailPreference": {"enabled": true,
"ccEmails": ["user@example.com"
]
}
}
]
},
"travelArrangers": {"travelArrangers": [{"name": {"family1": "Gandas",
"family2": "FamilyTwo",
"given": "Vichitr",
"middle": "Kumar",
"suffix": "SR",
"preferred": "Don"
},
"email": "example@email.com",
"phoneNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"userId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"status": "PENDING"
}
]
},
"adhocUserInfo": {"profileOwner": {"userId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
},
"isSaved": false
},
"roles": [{"roleType": "COMPANY_ADMIN",
"roleMetadata": {"travelArrangerMetadata": {"arrangerFor": [{"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"sendConfirmationEmail": false,
"sendFlightStatsNotificationEmail": false
}
]
}
},
"metadata": {"roleType": "TRAVEL_ARRANGER",
"arrangerFor": [{"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"sendConfirmationEmail": false,
"sendFlightStatsNotificationEmail": false
}
]
}
}
]
}

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Query user

This endpoint queries user of given company based on given identifier like email or external ID. In case includeInactive is true, inactive users are also included in the response.

SecurityBearer

Request

query Parameters

companyId required	string <uuid> Identifier for company. Example: companyId=4974a66b-7493-4f41-908c-58ba81093947
email	string <email> Email of the user. One of email or externalId should be provided. Example: email=user@example.com
externalId	string External id of the user. Only one of email or externalId should be provided. Example: externalId=123456
includeInactive	boolean Default: false If true, include inactive users in the response. Example: includeInactive=true

Responses

200

401

Unauthorized

403

Forbidden

get/v2/users

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"length": 0,
"elements": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"email": "user@example.com",
"externalId": "user-1",
"persona": "EMPLOYEE",
"isActive": true
}
]
}

Get user

This endpoint gets user details for user ID.

SecurityBearer

Request

path Parameters

userId

required

string <uuid>

Identifier for user.

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

query Parameters

includeInactive

boolean

Default: false

Include inactive users in the response.

Example: includeInactive=true

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/users/{userId}

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"personalInfo": {"addresses": [{"addressLines": ["Golden Gate Bridge"
],
"administrativeArea": "CA",
"administrativeAreaName": "California",
"description": "San Francisco Home",
"isDefault": true,
"languageCode": "en",
"locality": "San Francisco",
"locationCode": "LAX",
"organization": "Spotnana",
"postalCode": "94130",
"continentCode": "AF",
"recipients": ["string"
],
"regionCode": "US",
"regionName": "America",
"revision": 1,
"sortingCode": "Jamaica",
"sublocality": "string",
"timezone": "America/Los_Angeles",
"coordinates": {"latitude": 77.1025,
"longitude": 28.7041
}
}
],
"dob": {"iso8601": "2017-07-21"
},
"email": "example@email.com",
"emergencyContactInfo": {"address": {"addressLines": ["Golden Gate Bridge"
],
"administrativeArea": "CA",
"administrativeAreaName": "California",
"description": "San Francisco Home",
"isDefault": true,
"languageCode": "en",
"locality": "San Francisco",
"locationCode": "LAX",
"organization": "Spotnana",
"postalCode": "94130",
"continentCode": "AF",
"recipients": ["string"
],
"regionCode": "US",
"regionName": "America",
"revision": 1,
"sortingCode": "Jamaica",
"sublocality": "string",
"timezone": "America/Los_Angeles",
"coordinates": {"latitude": 77.1025,
"longitude": 28.7041
}
},
"designation": "MANAGER",
"email": "emergency-contact@email.com",
"name": {"family1": "Gandas",
"family2": "FamilyTwo",
"given": "Vichitr",
"middle": "Kumar",
"suffix": "SR",
"preferred": "Don"
},
"phoneNumber": {"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
},
"userOrgId": {"organizationAgencyId": {"id": "string"
},
"organizationId": {"id": "string"
},
"userId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"tmcInfo": {"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"primaryServiceProviderTmc": {"tmcId": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
}
},
"secondaryServiceProviderTmcs": [{"tmcId": {"id": null
},
"supplier": "SABRE",
"travelType": "AIR"
}
],
"partnerTmcId": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
}
},
"tmcBasicInfo": {"contractingTmc": {"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"name": "string",
"logo": {"data": "6935813e12584abda0e43d71cd2ea260",
"dimensions": {"height": null,
"width": null
},
"url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
}
},
"bookingTmc": {"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"name": "string",
"logo": {"data": "6935813e12584abda0e43d71cd2ea260",
"dimensions": {"height": null,
"width": null
},
"url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
}
}
}
}
},
"gender": "FEMALE",
"identityDocs": [{"passport": {"docId": "PASSPORTID",
"expiryDate": {"iso8601": "2017-07-21"
},
"issueCountry": "IN",
"issuedDate": {"iso8601": "2017-07-21"
},
"nationalityCountry": "IN",
"type": "REGULAR"
}
},
{"ktn": {"number": "123456",
"issueCountry": "US"
}
}
],
"name": {"family1": "Gandas",
"family2": "FamilyTwo",
"given": "Vichitr",
"middle": "Kumar",
"suffix": "SR",
"preferred": "Don"
},
"phoneNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"profilePicture": {"data": "6935813e12584abda0e43d71cd2ea260",
"dimensions": {"height": 120,
"width": 240
},
"url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
},
"nationality": "Indian",
"title": "MR",
"preferredLanguage": "en-US",
"preferredPronoun": "SHE_HER_HERS",
"travelerName": {"family1": "Gandas",
"family2": "FamilyTwo",
"given": "Vichitr",
"middle": "Kumar",
"suffix": "SR",
"preferred": "Don"
}
},
"businessInfo": {"departmentRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"designation": "MANAGER",
"email": "user@business.com",
"employeeId": "101",
"gradeRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"legalEntityRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"managerRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"officeRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"organizationRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"phoneNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"costCenterRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"countryCode": "USA",
"workerType": "EMPLOYEE",
"accountingCode": "123",
"companySpecifiedAttributes": [{"fixedColumnName": "contingentType",
"value": "FSTV"
}
],
"designatedApproverRefs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
],
"authorizerEmail": "example@email.com"
},
"persona": "EMPLOYEE",
"isActive": true,
"tier": "SEAT1A",
"relativeOf": {"userRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"relation": "SPOUSE"
},
"travelPreferences": {"preferences": {"airPref": {"airlinePrefs": [{"airlines": ["Indigo"
],
"flightType": "DOMESTIC"
}
],
"alliancePref": {"alliances": ["STAR_ALLIANCE"
]
},
"farePref": {"fareTypes": ["CHANGEABLE"
]
},
"homeAirport": "NEW YORK",
"mealPref": {"exclMealPrefs": ["VGML"
],
"inclMealPrefs": ["VGML"
],
"specialMealDescription": "Veg only meal"
},
"numStopPref": {"numOfStops": 34
},
"seatAmenityPref": {"seatAmenityTypes": ["WIFI"
]
},
"seatLocationPrefs": [{"cabins": ["FIRST"
],
"isBulkHeadPref": false,
"maxFlightDurationInHours": 3,
"position": "WINDOW"
}
],
"preferredAirports": [{"airportName": "San Francisco International Airport",
"airportCode": "SFO",
"label": "HOME"
}
]
},
"preferredCurrency": "USD",
"railCards": [{"cardNumber": "string",
"expiryDate": {"iso8601": "2017-07-21"
},
"name": "Veterans Railcard",
"spotnanaCode": "VET",
"vendor": "ATOC"
}
],
"railPref": {"preferredRailStations": [{"stationName": "Chicago Union Station",
"stationCode": "CHI",
"cityName": "Chicago",
"countryCode": "string",
"label": "HOME"
}
],
"seatPreference": {"hasAccessibility": false,
"seatTypes": ["NORMAL"
],
"seatLocations": ["AISLE"
],
"deckLevels": ["UPPER_DECK"
],
"seatDirections": ["FORWARD"
]
},
"travelClasses": ["FIRST"
],
"coachPreferences": ["NON_SMOKING"
],
"conditionalRates": ["AAA"
]
},
"carPref": {"vendors": [{"code": "ZE",
"name": "HERTZ",
"isPresentInPreferredVendors": true
}
],
"carTypes": ["ECONOMY"
],
"engineTypes": ["PETROL"
],
"transmissionTypes": ["AUTOMATIC"
],
"conditionalRates": ["AAA"
]
},
"hotelPref": {"hotelParentChains": [{"chainCode": "EM",
"chainName": "Mariott"
}
],
"hotelBrands": [{"brandCode": "HY",
"brandName": "Global Hytt Corp."
}
],
"hotelAmenityTypes": ["PARKING"
],
"roomPreference": {"isMobilityAccessible": false,
"bedCount": "ONE_BED",
"roomType": "SMOKING",
"mostImportantFact": "BED_COUNT",
"roomLocation": "HIGH_FLOOR",
"pillowType": "FOAM",
"roomAmenityPrefs": ["EXTRA_TOWELS"
]
},
"conditionalRates": ["AAA"
]
}
}
},
"membershipInfo": {"membershipInfos": [{"appliedTo": ["TAJ"
],
"id": "firstId",
"issuedBy": "firstIssuedBy",
"type": "AIR"
}
]
},
"notificationPreferences": {"preferences": [{"notificationType": "FLIGHT_NOTIFICATION",
"emailPreference": {"enabled": true,
"ccEmails": ["user@example.com"
]
}
}
]
},
"travelArrangers": {"travelArrangers": [{"name": {"family1": "Gandas",
"family2": "FamilyTwo",
"given": "Vichitr",
"middle": "Kumar",
"suffix": "SR",
"preferred": "Don"
},
"email": "example@email.com",
"phoneNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"userId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"status": "PENDING"
}
]
},
"adhocUserInfo": {"profileOwner": {"userId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
},
"isSaved": false
},
"externalId": "string"
}

Delete user

This endpoint deletes a user by user ID.

SecurityBearer

Request

path Parameters

userId

required

string <uuid>

Identifier for user.

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

Responses

204

No Content

401

Unauthorized

403

Forbidden

delete/v2/users/{userId}

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"debugIdentifier": "string",
"errorMessages": [{"errorCode": "string",
"message": "string",
"errorParameters": [{"name": "string",
"value": "string"
}
],
"errorDetail": "string"
}
]
}

Update user

SecurityBearer

Request

path Parameters

userId

required

string <uuid>

Identifier for user.

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

Request Body schema: application/json

required	object (UserPersonalInfo) User details.
required	object (BusinessInfo) User business information.
persona required	string (Persona) Persona of the user Enum: "UNKNOWN_PERSONA" "EMPLOYEE" "GUEST" "PERSONAL" "RELATIVE" "ADHOC"
tier	string (Tier) Tier of User Enum: "BASIC" "SEAT1A"
	object (RelativeOf) Link to primary traveler
	object (TravelPreferences) User's travel preferences
	object (MembershipInfo) User's travel preferences
	object (NotificationPreferences) Notification preferences of a user for different notification types.
	object (AdhocUserInfo) Basic information related to ad-hoc traveler profile.
externalId	string External id of this user.
	object (UserTravelArrangers) Deprecated Travel arrangers for a user.

Responses

200

No Content

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

put/v2/users/{userId}

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"personalInfo": {"addresses": [{"addressLines": ["Golden Gate Bridge"
],
"administrativeArea": "CA",
"administrativeAreaName": "California",
"description": "San Francisco Home",
"isDefault": true,
"languageCode": "en",
"locality": "San Francisco",
"locationCode": "LAX",
"organization": "Spotnana",
"postalCode": "94130",
"continentCode": "AF",
"recipients": ["string"
],
"regionCode": "US",
"regionName": "America",
"revision": 1,
"sortingCode": "Jamaica",
"sublocality": "string",
"timezone": "America/Los_Angeles",
"coordinates": {"latitude": 77.1025,
"longitude": 28.7041
}
}
],
"dob": {"iso8601": "2017-07-21"
},
"email": "example@email.com",
"emergencyContactInfo": {"address": {"addressLines": ["Golden Gate Bridge"
],
"administrativeArea": "CA",
"administrativeAreaName": "California",
"description": "San Francisco Home",
"isDefault": true,
"languageCode": "en",
"locality": "San Francisco",
"locationCode": "LAX",
"organization": "Spotnana",
"postalCode": "94130",
"continentCode": "AF",
"recipients": ["string"
],
"regionCode": "US",
"regionName": "America",
"revision": 1,
"sortingCode": "Jamaica",
"sublocality": "string",
"timezone": "America/Los_Angeles",
"coordinates": {"latitude": 77.1025,
"longitude": 28.7041
}
},
"designation": "MANAGER",
"email": "emergency-contact@email.com",
"name": {"family1": "Gandas",
"family2": "FamilyTwo",
"given": "Vichitr",
"middle": "Kumar",
"suffix": "SR",
"preferred": "Don"
},
"phoneNumber": {"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
},
"userOrgId": {"organizationAgencyId": {"id": "string"
},
"organizationId": {"id": "string"
},
"userId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"tmcInfo": {"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"primaryServiceProviderTmc": {"tmcId": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
}
},
"secondaryServiceProviderTmcs": [{"tmcId": {"id": null
},
"supplier": "SABRE",
"travelType": "AIR"
}
],
"partnerTmcId": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
}
},
"tmcBasicInfo": {"contractingTmc": {"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"name": "string",
"logo": {"data": "6935813e12584abda0e43d71cd2ea260",
"dimensions": {"height": null,
"width": null
},
"url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
}
},
"bookingTmc": {"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"name": "string",
"logo": {"data": "6935813e12584abda0e43d71cd2ea260",
"dimensions": {"height": null,
"width": null
},
"url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
}
}
}
}
},
"gender": "FEMALE",
"identityDocs": [{"passport": {"docId": "PASSPORTID",
"expiryDate": {"iso8601": "2017-07-21"
},
"issueCountry": "IN",
"issuedDate": {"iso8601": "2017-07-21"
},
"nationalityCountry": "IN",
"type": "REGULAR"
}
},
{"ktn": {"number": "123456",
"issueCountry": "US"
}
}
],
"name": {"family1": "Gandas",
"family2": "FamilyTwo",
"given": "Vichitr",
"middle": "Kumar",
"suffix": "SR",
"preferred": "Don"
},
"phoneNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"profilePicture": {"data": "6935813e12584abda0e43d71cd2ea260",
"dimensions": {"height": 120,
"width": 240
},
"url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
},
"nationality": "Indian",
"title": "MR",
"preferredLanguage": "en-US",
"preferredPronoun": "SHE_HER_HERS",
"travelerName": {"family1": "Gandas",
"family2": "FamilyTwo",
"given": "Vichitr",
"middle": "Kumar",
"suffix": "SR",
"preferred": "Don"
}
},
"businessInfo": {"departmentRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"designation": "MANAGER",
"email": "user@business.com",
"employeeId": "101",
"gradeRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"legalEntityRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"managerRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"officeRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"organizationRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"phoneNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"costCenterRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"countryCode": "USA",
"workerType": "EMPLOYEE",
"accountingCode": "123",
"companySpecifiedAttributes": [{"fixedColumnName": "contingentType",
"value": "FSTV"
}
],
"designatedApproverRefs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
],
"authorizerEmail": "example@email.com"
},
"persona": "EMPLOYEE",
"tier": "SEAT1A",
"relativeOf": {"userRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"relation": "SPOUSE"
},
"travelPreferences": {"preferences": {"airPref": {"airlinePrefs": [{"airlines": ["Indigo"
],
"flightType": "DOMESTIC"
}
],
"alliancePref": {"alliances": ["STAR_ALLIANCE"
]
},
"farePref": {"fareTypes": ["CHANGEABLE"
]
},
"homeAirport": "NEW YORK",
"mealPref": {"exclMealPrefs": ["VGML"
],
"inclMealPrefs": ["VGML"
],
"specialMealDescription": "Veg only meal"
},
"numStopPref": {"numOfStops": 34
},
"seatAmenityPref": {"seatAmenityTypes": ["WIFI"
]
},
"seatLocationPrefs": [{"cabins": ["FIRST"
],
"isBulkHeadPref": false,
"maxFlightDurationInHours": 3,
"position": "WINDOW"
}
],
"preferredAirports": [{"airportName": "San Francisco International Airport",
"airportCode": "SFO",
"label": "HOME"
}
]
},
"preferredCurrency": "USD",
"railCards": [{"cardNumber": "string",
"expiryDate": {"iso8601": "2017-07-21"
},
"name": "Veterans Railcard",
"spotnanaCode": "VET",
"vendor": "ATOC"
}
],
"railPref": {"preferredRailStations": [{"stationName": "Chicago Union Station",
"stationCode": "CHI",
"cityName": "Chicago",
"countryCode": "string",
"label": "HOME"
}
],
"seatPreference": {"hasAccessibility": false,
"seatTypes": ["NORMAL"
],
"seatLocations": ["AISLE"
],
"deckLevels": ["UPPER_DECK"
],
"seatDirections": ["FORWARD"
]
},
"travelClasses": ["FIRST"
],
"coachPreferences": ["NON_SMOKING"
],
"conditionalRates": ["AAA"
]
},
"carPref": {"vendors": [{"code": "ZE",
"name": "HERTZ",
"isPresentInPreferredVendors": true
}
],
"carTypes": ["ECONOMY"
],
"engineTypes": ["PETROL"
],
"transmissionTypes": ["AUTOMATIC"
],
"conditionalRates": ["AAA"
]
},
"hotelPref": {"hotelParentChains": [{"chainCode": "EM",
"chainName": "Mariott"
}
],
"hotelBrands": [{"brandCode": "HY",
"brandName": "Global Hytt Corp."
}
],
"hotelAmenityTypes": ["PARKING"
],
"roomPreference": {"isMobilityAccessible": false,
"bedCount": "ONE_BED",
"roomType": "SMOKING",
"mostImportantFact": "BED_COUNT",
"roomLocation": "HIGH_FLOOR",
"pillowType": "FOAM",
"roomAmenityPrefs": ["EXTRA_TOWELS"
]
},
"conditionalRates": ["AAA"
]
}
}
},
"membershipInfo": {"membershipInfos": [{"appliedTo": ["TAJ"
],
"id": "firstId",
"issuedBy": "firstIssuedBy",
"type": "AIR"
}
]
},
"notificationPreferences": {"preferences": [{"notificationType": "FLIGHT_NOTIFICATION",
"emailPreference": {"enabled": true,
"ccEmails": ["user@example.com"
]
}
}
]
},
"adhocUserInfo": {"profileOwner": {"userId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
},
"isSaved": false
},
"externalId": "string",
"travelArrangers": {"travelArrangers": [{"name": {"family1": "Gandas",
"family2": "FamilyTwo",
"given": "Vichitr",
"middle": "Kumar",
"suffix": "SR",
"preferred": "Don"
},
"email": "example@email.com",
"phoneNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"userId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"status": "PENDING"
}
]
}
}

Response samples

application/json

{"debugIdentifier": "string",
"errorMessages": [{"errorCode": "string",
"message": "string",
"errorParameters": [{"name": "string",
"value": "string"
}
],
"errorDetail": "string"
}
]
}

Get user business info

This endpoint gets user business info by user ID.

SecurityBearer

Request

path Parameters

userId

required

string <uuid>

Identifier for user.

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

query Parameters

includeInactive

boolean

Default: false

Include inactive users.

Example: includeInactive=true

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/users/{userId}/business-info

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"departmentRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"designation": "MANAGER",
"email": "user@business.com",
"employeeId": "101",
"gradeRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"legalEntityRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"managerRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"officeRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"organizationRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"phoneNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"costCenterRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"countryCode": "USA",
"workerType": "EMPLOYEE",
"accountingCode": "123",
"companySpecifiedAttributes": [{"fixedColumnName": "contingentType",
"value": "FSTV"
}
],
"designatedApproverRefs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
],
"authorizerEmail": "example@email.com"
}

Update user business info

This endpoint updates user business info by user ID.

SecurityBearer

Request

path Parameters

userId

required

string <uuid>

Identifier for user.

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

query Parameters

includeInactive

boolean

Default: false

Include inactive users.

Example: includeInactive=true

Request Body schema: application/json

	object (Reference) Reference of an entity
designation	string
email	string <email>
employeeId	string Unique employee id. Can use email if a company don't use employee ids.
	object (Reference) Reference of an entity
required	object (Reference) Reference of an entity
	object (Reference) Reference of an entity
	object (Reference) Reference of an entity
required	object (Reference) Reference of an entity
	Array of objects (PhoneNumber)
	object (Reference) Reference of an entity
countryCode	string alpha-2 or alpha-3 ISO country code.
workerType	string (WorkerType) The type of worker. Enum: "EMPLOYEE" "CONTINGENT" "SEASONAL" "INTERN"
accountingCode	string Code used for accounting.
	Array of objects (CompanySpecifiedAttribute)
	Array of objects (Reference object containing uuid and name of the entity.) A list of references for designated approvers.
authorizerEmail	string Deprecated Email address to be used as approval authorizer, when a manager is not present.

Responses

204

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

put/v2/users/{userId}/business-info

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"departmentRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"designation": "MANAGER",
"email": "user@business.com",
"employeeId": "101",
"gradeRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"legalEntityRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"managerRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"officeRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"organizationRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"phoneNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"costCenterRef": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"countryCode": "USA",
"workerType": "EMPLOYEE",
"accountingCode": "123",
"companySpecifiedAttributes": [{"fixedColumnName": "contingentType",
"value": "FSTV"
}
],
"designatedApproverRefs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
],
"authorizerEmail": "example@email.com"
}

Response samples

application/json

{"debugIdentifier": "string",
"errorMessages": [{"errorCode": "string",
"message": "string",
"errorParameters": [{"name": "string",
"value": "string"
}
],
"errorDetail": "string"
}
]
}

Get user personal info

This endpoint gets user personal info by user ID.

SecurityBearer

Request

path Parameters

userId

required

string <uuid>

Identifier for user.

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

query Parameters

includeInactive

boolean

Default: false

Include inactive users.

Example: includeInactive=true

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/users/{userId}/personal-info

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"addresses": [{"addressLines": ["Golden Gate Bridge"
],
"administrativeArea": "CA",
"administrativeAreaName": "California",
"description": "San Francisco Home",
"isDefault": true,
"languageCode": "en",
"locality": "San Francisco",
"locationCode": "LAX",
"organization": "Spotnana",
"postalCode": "94130",
"continentCode": "AF",
"recipients": ["string"
],
"regionCode": "US",
"regionName": "America",
"revision": 1,
"sortingCode": "Jamaica",
"sublocality": "string",
"timezone": "America/Los_Angeles",
"coordinates": {"latitude": 77.1025,
"longitude": 28.7041
}
}
],
"dob": {"iso8601": "2017-07-21"
},
"email": "example@email.com",
"emergencyContactInfo": {"address": {"addressLines": ["Golden Gate Bridge"
],
"administrativeArea": "CA",
"administrativeAreaName": "California",
"description": "San Francisco Home",
"isDefault": true,
"languageCode": "en",
"locality": "San Francisco",
"locationCode": "LAX",
"organization": "Spotnana",
"postalCode": "94130",
"continentCode": "AF",
"recipients": ["string"
],
"regionCode": "US",
"regionName": "America",
"revision": 1,
"sortingCode": "Jamaica",
"sublocality": "string",
"timezone": "America/Los_Angeles",
"coordinates": {"latitude": 77.1025,
"longitude": 28.7041
}
},
"designation": "MANAGER",
"email": "emergency-contact@email.com",
"name": {"family1": "Gandas",
"family2": "FamilyTwo",
"given": "Vichitr",
"middle": "Kumar",
"suffix": "SR",
"preferred": "Don"
},
"phoneNumber": {"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
},
"userOrgId": {"organizationAgencyId": {"id": "string"
},
"organizationId": {"id": "string"
},
"userId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"tmcInfo": {"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"primaryServiceProviderTmc": {"tmcId": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
}
},
"secondaryServiceProviderTmcs": [{"tmcId": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"supplier": "SABRE",
"travelType": "AIR"
}
],
"partnerTmcId": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
}
},
"tmcBasicInfo": {"contractingTmc": {"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"name": "string",
"logo": {"data": "6935813e12584abda0e43d71cd2ea260",
"dimensions": {"height": 120,
"width": 240
},
"url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
}
},
"bookingTmc": {"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"name": "string",
"logo": {"data": "6935813e12584abda0e43d71cd2ea260",
"dimensions": {"height": 120,
"width": 240
},
"url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
}
}
}
}
},
"gender": "FEMALE",
"identityDocs": [{"passport": {"docId": "PASSPORTID",
"expiryDate": {"iso8601": "2017-07-21"
},
"issueCountry": "IN",
"issuedDate": {"iso8601": "2017-07-21"
},
"nationalityCountry": "IN",
"type": "REGULAR"
}
},
{"ktn": {"number": "123456",
"issueCountry": "US"
}
}
],
"name": {"family1": "Gandas",
"family2": "FamilyTwo",
"given": "Vichitr",
"middle": "Kumar",
"suffix": "SR",
"preferred": "Don"
},
"phoneNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"profilePicture": {"data": "6935813e12584abda0e43d71cd2ea260",
"dimensions": {"height": 120,
"width": 240
},
"url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
},
"nationality": "Indian",
"title": "MR",
"preferredLanguage": "en-US",
"preferredPronoun": "SHE_HER_HERS",
"travelerName": {"family1": "Gandas",
"family2": "FamilyTwo",
"given": "Vichitr",
"middle": "Kumar",
"suffix": "SR",
"preferred": "Don"
}
}

Update user personal info

This endpoint updates user personal info by user ID.

SecurityBearer

Request

path Parameters

userId

required

string <uuid>

Identifier for user.

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

query Parameters

includeInactive

boolean

Default: false

Include inactive users.

Example: includeInactive=true

Request Body schema: application/json

	Array of objects (PostalAddress)
	object (DateModel) Date in ISO 8601 standard.
email	string <email>
	object (EmergencyContactInfo) Emergency contact information.
gender	string (Gender) Enum: "MALE" "FEMALE" "UNSPECIFIED" "UNDISCLOSED"
	Array of PassportWrapper (object) or ImmigrationDocumentWrapper (object) or RedressNumberWrapper (object) or KnownTravelerNumberWrapper (object) or NationalDocWrapper (object) (IdentityDocument) List of user identity documents.
	object (Name) Full name containing first, middle, last (family) names, and suffix.
	Array of objects (PhoneNumber)
	object (Image) An image with meta data. Either the `data` or `url` property must be supplied to load the image.
nationality	string Nationality of user
title	string (UserTitle) Enum: "TITLE_UNKNOWN" "MR" "MS" "MRS" "MX" "MASTER" "MISS" "DR" "PROFESSOR" "CAPTAIN" "REVEREND" "HONOURABLE" "SIR" "LADY" "AMBASSADOR" "LORD" "BRIGADIER" "SENATOR" "DAME" "JUSTICE" "UK"
preferredLanguage	string Language preferred by user.
preferredPronoun	string (PreferredPronoun) Pronoun preferred by user. Enum: "SHE_HER_HERS" "HE_HIM_HIS" "THEY_THEM_THEIRS"
	object (Name) A name of user that does not contain special characters.

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

put/v2/users/{userId}/personal-info

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"addresses": [{"addressLines": ["Golden Gate Bridge"
],
"administrativeArea": "CA",
"administrativeAreaName": "California",
"description": "San Francisco Home",
"isDefault": true,
"languageCode": "en",
"locality": "San Francisco",
"locationCode": "LAX",
"organization": "Spotnana",
"postalCode": "94130",
"continentCode": "AF",
"recipients": ["string"
],
"regionCode": "US",
"regionName": "America",
"revision": 1,
"sortingCode": "Jamaica",
"sublocality": "string",
"timezone": "America/Los_Angeles",
"coordinates": {"latitude": 77.1025,
"longitude": 28.7041
}
}
],
"dob": {"iso8601": "2017-07-21"
},
"email": "example@email.com",
"emergencyContactInfo": {"address": {"addressLines": ["Golden Gate Bridge"
],
"administrativeArea": "CA",
"administrativeAreaName": "California",
"description": "San Francisco Home",
"isDefault": true,
"languageCode": "en",
"locality": "San Francisco",
"locationCode": "LAX",
"organization": "Spotnana",
"postalCode": "94130",
"continentCode": "AF",
"recipients": ["string"
],
"regionCode": "US",
"regionName": "America",
"revision": 1,
"sortingCode": "Jamaica",
"sublocality": "string",
"timezone": "America/Los_Angeles",
"coordinates": {"latitude": 77.1025,
"longitude": 28.7041
}
},
"designation": "MANAGER",
"email": "emergency-contact@email.com",
"name": {"family1": "Gandas",
"family2": "FamilyTwo",
"given": "Vichitr",
"middle": "Kumar",
"suffix": "SR",
"preferred": "Don"
},
"phoneNumber": {"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
},
"userOrgId": {"organizationAgencyId": {"id": "string"
},
"organizationId": {"id": "string"
},
"userId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"tmcInfo": {"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"primaryServiceProviderTmc": {"tmcId": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
}
},
"secondaryServiceProviderTmcs": [{"tmcId": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"supplier": "SABRE",
"travelType": "AIR"
}
],
"partnerTmcId": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
}
},
"tmcBasicInfo": {"contractingTmc": {"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"name": "string",
"logo": {"data": "6935813e12584abda0e43d71cd2ea260",
"dimensions": {"height": 120,
"width": 240
},
"url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
}
},
"bookingTmc": {"id": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"name": "string",
"logo": {"data": "6935813e12584abda0e43d71cd2ea260",
"dimensions": {"height": 120,
"width": 240
},
"url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
}
}
}
}
},
"gender": "FEMALE",
"identityDocs": [{"passport": {"docId": "PASSPORTID",
"expiryDate": {"iso8601": "2017-07-21"
},
"issueCountry": "IN",
"issuedDate": {"iso8601": "2017-07-21"
},
"nationalityCountry": "IN",
"type": "REGULAR"
}
},
{"ktn": {"number": "123456",
"issueCountry": "US"
}
}
],
"name": {"family1": "Gandas",
"family2": "FamilyTwo",
"given": "Vichitr",
"middle": "Kumar",
"suffix": "SR",
"preferred": "Don"
},
"phoneNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"profilePicture": {"data": "6935813e12584abda0e43d71cd2ea260",
"dimensions": {"height": 120,
"width": 240
},
"url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
},
"nationality": "Indian",
"title": "MR",
"preferredLanguage": "en-US",
"preferredPronoun": "SHE_HER_HERS",
"travelerName": {"family1": "Gandas",
"family2": "FamilyTwo",
"given": "Vichitr",
"middle": "Kumar",
"suffix": "SR",
"preferred": "Don"
}
}

Response samples

application/json

{"debugIdentifier": "string",
"errorMessages": [{"errorCode": "string",
"message": "string",
"errorParameters": [{"name": "string",
"value": "string"
}
],
"errorDetail": "string"
}
]
}

Get user travel preferences

SecurityBearer

Request

path Parameters

userId

required

string <uuid>

Identifier for user.

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

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/users/{userId}/travel-preferences

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"preferences": {"airPref": {"airlinePrefs": [{"airlines": ["Indigo"
],
"flightType": "DOMESTIC"
}
],
"alliancePref": {"alliances": ["STAR_ALLIANCE"
]
},
"farePref": {"fareTypes": ["CHANGEABLE"
]
},
"homeAirport": "NEW YORK",
"mealPref": {"exclMealPrefs": ["VGML"
],
"inclMealPrefs": ["VGML"
],
"specialMealDescription": "Veg only meal"
},
"numStopPref": {"numOfStops": 34
},
"seatAmenityPref": {"seatAmenityTypes": ["WIFI"
]
},
"seatLocationPrefs": [{"cabins": ["FIRST"
],
"isBulkHeadPref": false,
"maxFlightDurationInHours": 3,
"position": "WINDOW"
}
],
"preferredAirports": [{"airportName": "San Francisco International Airport",
"airportCode": "SFO",
"label": "HOME"
}
]
},
"preferredCurrency": "USD",
"railCards": [{"cardNumber": "string",
"expiryDate": {"iso8601": "2017-07-21"
},
"name": "Veterans Railcard",
"spotnanaCode": "VET",
"vendor": "ATOC"
}
],
"railPref": {"preferredRailStations": [{"stationName": "Chicago Union Station",
"stationCode": "CHI",
"cityName": "Chicago",
"countryCode": "string",
"label": "HOME"
}
],
"seatPreference": {"hasAccessibility": false,
"seatTypes": ["NORMAL"
],
"seatLocations": ["AISLE"
],
"deckLevels": ["UPPER_DECK"
],
"seatDirections": ["FORWARD"
]
},
"travelClasses": ["FIRST"
],
"coachPreferences": ["NON_SMOKING"
],
"conditionalRates": ["AAA"
]
},
"carPref": {"vendors": [{"code": "ZE",
"name": "HERTZ",
"isPresentInPreferredVendors": true
}
],
"carTypes": ["ECONOMY"
],
"engineTypes": ["PETROL"
],
"transmissionTypes": ["AUTOMATIC"
],
"conditionalRates": ["AAA"
]
},
"hotelPref": {"hotelParentChains": [{"chainCode": "EM",
"chainName": "Mariott"
}
],
"hotelBrands": [{"brandCode": "HY",
"brandName": "Global Hytt Corp."
}
],
"hotelAmenityTypes": ["PARKING"
],
"roomPreference": {"isMobilityAccessible": false,
"bedCount": "ONE_BED",
"roomType": "SMOKING",
"mostImportantFact": "BED_COUNT",
"roomLocation": "HIGH_FLOOR",
"pillowType": "FOAM",
"roomAmenityPrefs": ["EXTRA_TOWELS"
]
},
"conditionalRates": ["AAA"
]
}
}
}

Update user travel preferences

SecurityBearer

Request

path Parameters

userId

required

string <uuid>

Identifier for user.

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

Request Body schema: application/json

object (TravelPref)

Travel preferences.

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

put/v2/users/{userId}/travel-preferences

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"preferences": {"airPref": {"airlinePrefs": [{"airlines": ["Indigo"
],
"flightType": "DOMESTIC"
}
],
"alliancePref": {"alliances": ["STAR_ALLIANCE"
]
},
"farePref": {"fareTypes": ["CHANGEABLE"
]
},
"homeAirport": "NEW YORK",
"mealPref": {"exclMealPrefs": ["VGML"
],
"inclMealPrefs": ["VGML"
],
"specialMealDescription": "Veg only meal"
},
"numStopPref": {"numOfStops": 34
},
"seatAmenityPref": {"seatAmenityTypes": ["WIFI"
]
},
"seatLocationPrefs": [{"cabins": ["FIRST"
],
"isBulkHeadPref": false,
"maxFlightDurationInHours": 3,
"position": "WINDOW"
}
],
"preferredAirports": [{"airportName": "San Francisco International Airport",
"airportCode": "SFO",
"label": "HOME"
}
]
},
"preferredCurrency": "USD",
"railCards": [{"cardNumber": "string",
"expiryDate": {"iso8601": "2017-07-21"
},
"name": "Veterans Railcard",
"spotnanaCode": "VET",
"vendor": "ATOC"
}
],
"railPref": {"preferredRailStations": [{"stationName": "Chicago Union Station",
"stationCode": "CHI",
"cityName": "Chicago",
"countryCode": "string",
"label": "HOME"
}
],
"seatPreference": {"hasAccessibility": false,
"seatTypes": ["NORMAL"
],
"seatLocations": ["AISLE"
],
"deckLevels": ["UPPER_DECK"
],
"seatDirections": ["FORWARD"
]
},
"travelClasses": ["FIRST"
],
"coachPreferences": ["NON_SMOKING"
],
"conditionalRates": ["AAA"
]
},
"carPref": {"vendors": [{"code": "ZE",
"name": "HERTZ",
"isPresentInPreferredVendors": true
}
],
"carTypes": ["ECONOMY"
],
"engineTypes": ["PETROL"
],
"transmissionTypes": ["AUTOMATIC"
],
"conditionalRates": ["AAA"
]
},
"hotelPref": {"hotelParentChains": [{"chainCode": "EM",
"chainName": "Mariott"
}
],
"hotelBrands": [{"brandCode": "HY",
"brandName": "Global Hytt Corp."
}
],
"hotelAmenityTypes": ["PARKING"
],
"roomPreference": {"isMobilityAccessible": false,
"bedCount": "ONE_BED",
"roomType": "SMOKING",
"mostImportantFact": "BED_COUNT",
"roomLocation": "HIGH_FLOOR",
"pillowType": "FOAM",
"roomAmenityPrefs": ["EXTRA_TOWELS"
]
},
"conditionalRates": ["AAA"
]
}
}
}

Response samples

application/json

{"debugIdentifier": "string",
"errorMessages": [{"errorCode": "string",
"message": "string",
"errorParameters": [{"name": "string",
"value": "string"
}
],
"errorDetail": "string"
}
]
}

Get user membership info

SecurityBearer

Request

path Parameters

userId

required

string <uuid>

Identifier for user.

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

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/users/{userId}/membership-info

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"membershipInfos": [{"appliedTo": ["TAJ"
],
"id": "firstId",
"issuedBy": "firstIssuedBy",
"type": "AIR"
}
]
}

Update user membership info

SecurityBearer

Request

path Parameters

userId

required

string <uuid>

Identifier for user.

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

Request Body schema: application/json

Array of objects (LoyaltyInfo)

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

put/v2/users/{userId}/membership-info

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"membershipInfos": [{"appliedTo": ["TAJ"
],
"id": "firstId",
"issuedBy": "firstIssuedBy",
"type": "AIR"
}
]
}

Response samples

application/json

{"debugIdentifier": "string",
"errorMessages": [{"errorCode": "string",
"message": "string",
"errorParameters": [{"name": "string",
"value": "string"
}
],
"errorDetail": "string"
}
]
}

Update user roles

This endpoint updates user roles.

SecurityBearer

Request

path Parameters

userId

required

string <uuid>

Identifier for user.

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

Request Body schema: application/json

Array of objects (RoleConfig)

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

put/v2/users/{userId}/roles

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"roles": [{"roleType": "COMPANY_ADMIN",
"roleMetadata": {"travelArrangerMetadata": {"arrangerFor": [{"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"sendConfirmationEmail": false,
"sendFlightStatsNotificationEmail": false
}
]
}
},
"metadata": {"roleType": "TRAVEL_ARRANGER",
"arrangerFor": [{"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"sendConfirmationEmail": false,
"sendFlightStatsNotificationEmail": false
}
]
}
}
]
}

Response samples

application/json

{"debugIdentifier": "string",
"errorMessages": [{"errorCode": "string",
"message": "string",
"errorParameters": [{"name": "string",
"value": "string"
}
],
"errorDetail": "string"
}
]
}

Get user roles

This endpoint gets user roles.

SecurityBearer

Request

path Parameters

userId

required

string <uuid>

Identifier for user.

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

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/users/{userId}/roles

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"roles": [{"roleType": "COMPANY_ADMIN",
"roleMetadata": {"travelArrangerMetadata": {"arrangerFor": [{"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"sendConfirmationEmail": false,
"sendFlightStatsNotificationEmail": false
}
]
}
},
"metadata": {"roleType": "TRAVEL_ARRANGER",
"arrangerFor": [{"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"sendConfirmationEmail": false,
"sendFlightStatsNotificationEmail": false
}
]
}
}
]
}

Get notification preferences

This endpoint gets notification preferences for a user.

SecurityBearer

Request

path Parameters

userId

required

string <uuid>

Identifier for user.

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

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/users/{userId}/notification-preferences

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"preferences": [{"notificationType": "FLIGHT_NOTIFICATION",
"emailPreference": {"enabled": true,
"ccEmails": ["user@example.com"
]
}
}
]
}

Update notification preferences

This endpoint updates notification preferences for a user.

SecurityBearer

Request

path Parameters

userId

required

string <uuid>

Identifier for user.

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

Request Body schema: application/json

Array of objects (NotificationPreferencePerType)

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

put/v2/users/{userId}/notification-preferences

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"preferences": [{"notificationType": "FLIGHT_NOTIFICATION",
"emailPreference": {"enabled": true,
"ccEmails": ["user@example.com"
]
}
}
]
}

Response samples

application/json

{"debugIdentifier": "string",
"errorMessages": [{"errorCode": "string",
"message": "string",
"errorParameters": [{"name": "string",
"value": "string"
}
],
"errorDetail": "string"
}
]
}

Get user travel arrangers

SecurityBearer

Request

path Parameters

userId

required

string <uuid>

Identifier for user.

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

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/users/{userId}/travel-arrangers

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"travelArrangers": [{"name": {"family1": "Gandas",
"family2": "FamilyTwo",
"given": "Vichitr",
"middle": "Kumar",
"suffix": "SR",
"preferred": "Don"
},
"email": "example@email.com",
"phoneNumbers": [{"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
}
],
"userId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"status": "PENDING"
}
]
}

Get user's external ID

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

SecurityBearer

Request

path Parameters

userId

required

string <uuid>

Identifier for user.

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

query Parameters

includeInactive

boolean

Default: false

Include inactive users.

Example: includeInactive=true

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/users/{userId}/external-id

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"externalId": "user-1"
}

Update user's external ID

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

SecurityBearer

Request

path Parameters

userId

required

string <uuid>

Identifier for user.

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

query Parameters

includeInactive

boolean

Default: false

Include inactive users.

Example: includeInactive=true

Request Body schema: application/json

externalId

required

string

External id of user within partner database.

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

put/v2/users/{userId}/external-id

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"externalId": "user-1"
}

Response samples

application/json

{"debugIdentifier": "string",
"errorMessages": [{"errorCode": "string",
"message": "string",
"errorParameters": [{"name": "string",
"value": "string"
}
],
"errorDetail": "string"
}
]
}

Activate a user

This endpoint activates a deactivated user.

SecurityBearer

Request

path Parameters

userId

required

string <uuid>

Identifier for user.

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

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

post/v2/users/{userId}/activate

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"debugIdentifier": "string",
"errorMessages": [{"errorCode": "string",
"message": "string",
"errorParameters": [{"name": "string",
"value": "string"
}
],
"errorDetail": "string"
}
]
}

Get user policies

SecurityBearer

Request

path Parameters

userId

required

string <uuid>

Identifier for user.

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

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/users/{userId}/applicable-policies

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"policies": [{"id": "348fcc1c-c33a-4942-8834-a7888913dd66",
"name": "HR Policy"
}
]
}