Users

Patch user

This endpoint partially updates a user by user ID.

patch/v2/users/{userId}

Request body

persona'UNKNOWN_PERSONA' | 'EMPLOYEE' | 'GUEST' | 'PERSONAL' | 'RELATIVE' | 'ADHOC'

Persona of the user

tier'BASIC' | 'SEAT1A' | 'TIER_2' | 'TIER_3' | 'TIER_4' | 'TIER_5' | 'TIER_6' | 'TIER_7' | 'TIER_8' | 'TIER_9' | 'TIER_10' | 'TIER_11' | 'TIER_12' | 'TIER_13' | 'TIER_14' | 'TIER_15' | 'TIER_16' | 'TIER_17' | 'TIER_18' | 'TIER_19' | 'TIER_20' | 'TIER_21' | 'TIER_22' | 'TIER_23' | 'TIER_24' | 'TIER_25' | 'TIER_26' | 'TIER_27' | 'TIER_28' | 'TIER_29' | 'TIER_30' | 'TIER_31'

Tier of User. Note: In default UI, BASIC is displayed as Standard, and SEAT1A is displayed as VIP. Display names for other tiers are driven by the company tier configuration.

stealthType'STEALTH_TYPE_1' | 'STEALTH_TYPE_2' | 'STEALTH_TYPE_3'

Stealth type.

externalIdstring nullable

The partner-assigned user identifier.

Example request

{
  "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",
        "regionCode": "US",
        "regionName": "America",
        "revision": 1,
        "sortingCode": "Jamaica",
        "timezone": "America/Los_Angeles",
        "coordinates": {
          "latitude": 77.1025,
          "longitude": 28.7041
        }
      }
    ],
    "dob": {
      "iso8601": "2027-07-21"
    },
    "email": "example@email.com",
    "gender": "FEMALE",
    "identityDocs": [
      {
        "passport": {
          "docId": "PassportID",
          "expiryDate": {
            "iso8601": "2017-07-21"
          },
          "issueCountry": "IN",
          "issuedDate": {
            "iso8601": "2017-07-21"
          },
          "nationalityCountry": "IN",
          "type": "REGULAR"
        }
      }
    ],
    "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"
    },
    "emergencyContact": {
      "name": "John Smith",
      "email": "emergency-contact@email.com",
      "relation": "SPOUSE",
      "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"
        }
      ],
      "preferredLanguage": "en-US"
    }
  },
  "businessInfo": {
    "departmentRef": {
      "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
      "name": "Name"
    },
    "designation": "MANAGER",
    "email": "user@business.com",
    "employeeId": "101",
    "gradeRef": {
      "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
      "name": "Name"
    },
    "legalEntityRef": {
      "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
      "name": "Name"
    },
    "managerRef": {
      "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
      "name": "Name"
    },
    "officeRef": {
      "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
      "name": "Name"
    },
    "organizationRef": {
      "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
      "name": "Name"
    },
    "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": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
      "name": "Name"
    },
    "countryCode": "USA",
    "workerType": "EMPLOYEE",
    "accountingCode": "123",
    "companySpecifiedAttributes": [
      {
        "fixedColumnName": "contingentType",
        "value": "FSTV"
      }
    ],
    "designatedApproverRefs": [
      {
        "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
        "name": "Name"
      }
    ],
    "authorizerEmail": "example@email.com"
  },
  "persona": "EMPLOYEE",
  "tier": "SEAT1A",
  "stealthType": "STEALTH_TYPE_1",
  "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"
            ],
            "maxFlightDurationInHours": 3,
            "position": "WINDOW"
          }
        ],
        "preferredAirports": [
          {
            "airportName": "San Francisco International Airport",
            "airportCode": "SFO",
            "label": "HOME"
          }
        ]
      },
      "preferredCurrency": "USD",
      "railCards": [
        {
          "expiryDate": {
            "iso8601": "2017-07-21"
          },
          "name": "Veterans Railcard",
          "spotnanaCode": "VET",
          "vendor": "ATOC"
        }
      ],
      "railPref": {
        "preferredRailStations": [
          {
            "stationName": "Chicago Union Station",
            "stationCode": "CHI",
            "cityName": "Chicago",
            "label": "HOME"
          }
        ],
        "seatPreference": {
          "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."
          }
        ],
        "roomPreference": {
          "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",
        "tier": "GOLD"
      }
    ]
  }
}

Response

Updated successfully

Changes

Changed in 1 of the 6 revisions of this API.1