PUT /users/{userId}/profile

Request

Resource URL

PUT https://api.ft.com/users/{userId}/profile

For security reasons requests must be made over HTTPS.

Path Parameters

ParamValue
userId The unique identifier for the user whose profile is to be updated

Request Headers

HeaderValue
Content-Type
application/json
X-Api-Key <API key value>
Authorization

Bearer <Access token>

where <Access token> is as retrieved via the API Authorization Service for the given user whose profile is to be updated.

Request Body

A json representaion of the User Profile Request an example of which is shown below

{
 “user”: {
   “email”: “someone1@example.com”,
   “password”: “mys3cr3T”
   “firstName”: “Firstname”,
   “lastName”: “Lastname”,
   “title”: “Mr”,
   “primaryTelephone”: “442071234567”,
   “homeAddress”: {
     “line1”: “The White House”,
     “line2”: “1600 Pennsylvania Ave NW”,
     “townCity”: “Washington”,
     “postcode”: “20500”,
     “state”: “DC”,
     “country”: “USA”
   }
 }
}

Response

HTTP Status Codes

Http StatusDescription
200 Updated The user profile record was updated successfully
400 Bad request The request was invalid. You may refer to response for details around why the request was invalid
401 Unauthorised Invalid access token used
403 Forbidden Invalid API key
404 Not found User record to update not found
415 Unsopported Media Type Ensure you use the correct Content-Type header in the request as indicated in the Request Headers section above

200 Updated - The user profile records was updated successfully

If successful, this method returns a User Profile Resource.

400 Bad request - The request was invalid 

An Error Response with the following format.

{
  “message”: “Validation failed.”,
  “transactionId”: “88452f9a-15b2-4ffe-869f-29532679e407”
  “errors”: [
    {
      “resource”: “user”,
      “field”: “email”,
      “errorCode”: “email.violation.duplicate”,
      “message”: “An FT.com account already exists with this email address. Please use a different email address”,
      “invalidValue”: “someone@example.com”
    }
  ]
}

401 Unauthorized - Invalud access token used

This endpoint requires a valid access token. A valid access token can be requested from the API Authorization Service.

403 Forbidden - Your access to the API endpoint was denied

Make sure you are using a valid API key. If you are sure your are using a valid API key and problems persist, contact us for assistance.

404 Not found - User not found

UserId provided is invalid and hence a valid user record could not be found.

415 Unsupported Media Type - Ensure you use the correct Content-Type header

Make sure you use Content-Type header with value “application/json” in the request.