Update User Details

PUT

/v2/employee/:employeeId

PUT

/v2/employee/:employeeId

curl -X PUT https://api.megaport.com/v2/employee/employeeId \
     -H "Content-Type: application/json" \
     -d '[
  {
    "active": true,
    "altId": "Google_156979315619591871227",
    "email": "jeffrey@megaport.com",
    "emails": [
      {
        "badEmail": false,
        "email": "jeffrey@megaport.com",
        "emailAddressId": 5020,
        "primary": true
      }
    ],
    "featureFlags": [],
    "firstName": "Jeffrey",
    "googlePlus": "https://plus.google.com/100987315619591971225",
    "lastName": "Megaport",
    "mobile": "+61 408227543",
    "name": "Jeffrey Megaport",
    "newsletter": true,
    "notificationEnabled": true,
    "partyId": 45115,
    "phone": "+61 408227543",
    "position": "Company Admin",
    "promotions": true,
    "requireTotp": false,
    "salesforceId": "0736F00113utfdsQAB",
    "securityRoles": [
      "companyAdmin"
    ],
    "uid": "c3ba48e8-20ed-41c3-91ae-c23ad8d3c29e",
    "username": "jeffrey@megaport.com"
  }
]'

{
  "message": "Employee has been updated.",
  "terms": "This data is subject to the Acceptable Use Policy https://www.megaport.com/legal/acceptable-use-policy"
}

Updates user information for the user specified by the employee ID.

You can find the employee ID (personId) using the GET List Company Users /v2/employment endpoint.

The changes are defined in the Body of the request. Only include the attributes that you want to update.

The attributes have these values.

notificationEnabled - (Boolean) - Notification setup of the user.
position - (String) Role of the user. For more information on roles, see POST Invite (Add) a New User to an Existing Company.
newsletter - (Boolean) - Newsletter setup of the user.
promotions - (Boolean) - Promotions setup of the user.
firstName - (String) First name of the user.
lastName - (String) Last name of the user.
phone - (String) Phone number of the user.
requireTotp - (Boolean) Defines whether the user requires a time-based one-time password.
active - (Boolean) Set this value to true if the user is active or set this value to false to define the user as Inactive.
securityRoles - (Array of strings) Security roles of the user. For example, companyAdmin, technicalContact.
mobile - (String) Mobile phone number of the user.
email - (String) Email address of the user.
partyId - (String) - Employee ID of the user. Same as the personId.
altId - (String) Google ID of the user.
username - (String) - Username of the user.
uid - (String) - Uid of the user.
googlePlus - (String) Google Link of the user.
salesforceId - (String) Salesforce ID of the user.
name - (String) - Full name of the user.
emails - (Array of objects (Email)) Email object of the user.
- emailAddressId (Integer) - Email address ID.
- email (String) - Email address.
- primary (Boolean) - Defines whether the email is the primary email address of the user.
- badEmail (Boolean) - Is the email given in the correct format?

Path parameters

employeeIdstringRequired

Request

This endpoint expects a list of objects.

activebooleanOptional

altIdstringOptional

emailstringOptional

emailslist of objectsOptional

featureFlagslist of anyOptional

firstNamestringOptional

googlePlusstringOptional

lastNamestringOptional

mobilestringOptional

namestringOptional

notificationEnabledbooleanOptional

partyIddoubleOptional

phonestringOptional

positionstringOptional

promotionsbooleanOptional

requireTotpbooleanOptional

salesforceIdstringOptional

securityRoleslist of stringsOptional

uidstringOptional

usernamestringOptional

Response

Update User Details - Success / Update User Details - Success

messagestringOptional

termsstringOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error