User

Patch user profile

Changed on

Update a marketplace user's profile. Also marks user's checklist with profile as completed.

patch/account/v2/users/{userUuid}/profile

Request

Path parameters

userUuidstring required

Unique identifier of user in the API request

Query parameters

removeUnspecifiedCustomAttributesboolean

When true, custom attributes not included in the body will be removed from the user's profile. When false, custom attributes not included in the body will remain in the user's profile, unmodified.

Request body

birthdaystring

Birthday date

currentCitystring

Current city

homePhonestring

Home phone number

hometownstring

Hometown

mobilePhonestring

Mobile phone number

twitterstring

Twitter account

twoFactorAuthenticationMethodstring

Two factor authentication method

workPhonestring

Work phone number

Example request

{
  "birthday": "1999/9/9",
  "currentCity": "Current City",
  "customAttributes": [],
  "educations": [
    {
      "current": false,
      "degree": "bachelor's",
      "endYear": 2010,
      "field": "Computer Science",
      "school": "MIT",
      "startYear": 2007
    }
  ],
  "emailAddresses": [
    {
      "address": "alternate@company.com",
      "type": "WORK",
      "verified": false
    }
  ],
  "homePhone": "+1 123 123 1234",
  "hometown": "Home Town",
  "ims": [
    {
      "account": "someAccount",
      "type": "OTHER"
    },
    {
      "account": "someAccount",
      "type": "OTHER"
    },
    {
      "account": "someAccount",
      "type": "OTHER"
    }
  ],
  "links": [
    {
      "href": "http://appdirect/api/account/v2/users/48dc0e2b-995b-4013-bd3f-2946309ca0fd",
      "rel": "user"
    }
  ],
  "mobilePhone": "+1 123 ",
  "twitter": "twitter_account",
  "twoFactorAuthenticationMethod": "twoFactorAuthenticationIsGreat",
  "workExperiences": [
    {
      "current": true,
      "description": "Developer @ Appdirect",
      "employer": "Appdirect",
      "endYear": 2017,
      "position": "Manager",
      "startYear": 2011
    }
  ],
  "workPhone": "+1 123 123 1234"
}

Response

Success

birthdaystring

Birthday date

currentCitystring

Current city

homePhonestring

Home phone number

hometownstring

Hometown

mobilePhonestring

Mobile phone number

twitterstring

Twitter account

twoFactorAuthenticationMethodstring

Two factor authentication method

workPhonestring

Work phone number

Example response

{
  "birthday": "1999/9/9",
  "currentCity": "Current City",
  "customAttributes": [],
  "educations": [
    {
      "current": false,
      "degree": "bachelor's",
      "endYear": 2010,
      "field": "Computer Science",
      "school": "MIT",
      "startYear": 2007
    }
  ],
  "emailAddresses": [
    {
      "address": "alternate@company.com",
      "type": "WORK",
      "verified": false
    }
  ],
  "homePhone": "+1 123 123 1234",
  "hometown": "Home Town",
  "ims": [
    {
      "account": "someAccount",
      "type": "OTHER"
    },
    {
      "account": "someAccount",
      "type": "OTHER"
    },
    {
      "account": "someAccount",
      "type": "OTHER"
    }
  ],
  "links": [
    {
      "href": "http://appdirect/api/account/v2/users/48dc0e2b-995b-4013-bd3f-2946309ca0fd",
      "rel": "user"
    }
  ],
  "mobilePhone": "+1 123 ",
  "twitter": "twitter_account",
  "twoFactorAuthenticationMethod": "twoFactorAuthenticationIsGreat",
  "workExperiences": [
    {
      "current": true,
      "description": "Developer @ Appdirect",
      "employer": "Appdirect",
      "endYear": 2017,
      "position": "Manager",
      "startYear": 2011
    }
  ],
  "workPhone": "+1 123 123 1234"
}

Changes

    • breaking

      added subschema #2: UserProfileAccountV2 to the request body allOf list

    • breaking

      removed the media type */* for the response with the status

    • breaking

      removed the media type */* for the response with the status