Test Environment. You are currently using the Webex for Developers test environment. Apps created here will not be available for use with Webex Teams. Please visit Webex for Developers to manage your apps.

Update a Person

Update details for a person, by ID.

Specify the person ID in the personId parameter in the URI. Only an admin can update a person details.

Include all details for the person. This action expects all user details to be present in the request. A common approach is to first GET the person's details, make changes, then PUT both the changed and unchanged values.

Admin users can include BroadCloud user details in the response by specifying callingData parameter as true.

Note: The locationId can only be set when adding a calling license to a user. It cannot be changed if a user is already an existing calling user.

PUT/v1/people/{personId}
URI Parameters
personId
stringrequired

A unique identifier for the person.

Query Parameters
callingData
boolean

Include BroadCloud user details in the response.

Default: false
Body Parameters
emails
array

The email addresses of the person. Only one email address is allowed per person.

Possible values: john.andersen@example.com
phoneNumbers
array

Phone numbers for the person.

type

The type of phone number.

Possible values: work
value

The phone number.

Possible values: 408 526 7209
extension
string

The extension of the person.

locationId
string

The ID of the location for this person.

displayName
string

The full name of the person.

firstName
string

The first name of the person.

lastName
string

The last name of the person.

avatar
string

The URL to the person's avatar in PNG format.

orgId
string

The ID of the organization to which this person belongs.

roles
array

An array of role strings representing the roles to which this person belongs.

Possible values: Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh, Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi
licenses
array

An array of license strings allocated to this person.

Possible values: Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh, Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi
Response Properties
id
string

A unique identifier for the person.

emails
array

The email addresses of the person.

phoneNumbers
array

Phone numbers for the person.

type

The type of phone number.

Possible values: work, mobile, fax
value

The phone number.

Possible values: +1 408 526 7209
extension
string

The extension of the person retrieved from BroadCloud.

locationId
string

The ID of the location for this person retrieved from BroadCloud.

displayName
string

The full name of the person.

nickName
string

The nickname of the person if configured. If no nickname is configured for the person, this field will not be present.

firstName
string

The first name of the person.

lastName
string

The last name of the person.

avatar
string

The URL to the person's avatar in PNG format.

orgId
string

The ID of the organization to which this person belongs.

roles
array

An array of role strings representing the roles to which this person belongs.

licenses
array

An array of license strings allocated to this person.

created
string

The date and time the person was created.

lastModified
string

The date and time the person was last changed.

timezone
string

The time zone of the person if configured. If no timezone is configured on the account, this field will not be present

lastActivity
string

The date and time of the person's last activity within Webex Teams. This will only be returned for people within your organization or an organization you manage. Presence information will not be shown if the authenticated user has disabled status sharing.

status
enum

The current presence status of the person. This will only be returned for people within your organization or an organization you manage. Presence information will not be shown if the authenticated user has disabled status sharing.

active

active within the last 10 minutes

call

the user is in a call

DoNotDisturb

the user has manually set their status to "Do Not Disturb"

inactive

last activity occurred more than 10 minutes ago

meeting

the user is in a meeting

OutOfOffice

the user or a Hybrid Calendar service has indicated that they are "Out of Office"

pending

the user has never logged in; a status cannot be determined

presenting

the user is sharing content

unknown

the user’s status could not be determined

invitePending
enum

Whether or not an invite is pending for the user to complete account activation. This property is only returned if the authenticated user is an admin user for the person's organization.

true

the person has been invited to Webex Teams but has not created an account

false

an invite is not pending for this person

loginEnabled
enum

Whether or not the user is allowed to use Webex Teams. This property is only returned if the authenticated user is an admin user for the person's organization.

true

the person can log into Webex Teams

false

the person cannot log into Webex Teams

type
enum

The type of person account, such as person or bot.

person

account belongs to a person

bot

account is a bot user

appuser

account is a guest user

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
PUT
/v1/people/{?callingData}
Log in to try the API.
Header
Query Parameters
  • Include BroadCloud user details in the response.
Body
  • The email addresses of the person. Only one email address is allowed per person.
  • Phone numbers for the person.
  • The extension of the person.
  • The ID of the location for this person.
  • The full name of the person.
  • The first name of the person.
  • The last name of the person.
  • The URL to the person's avatar in PNG format.
  • The ID of the organization to which this person belongs.
  • An array of role strings representing the roles to which this person belongs.
  • An array of license strings allocated to this person.
https://webexapis.com/v1/people/Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY?callingData=true
{
  "emails": [
    "john.andersen@example.com"
  ],
  "phoneNumbers": [
    {
      "type": "work",
      "value": "408 526 7209"
    }
  ],
  "extension": "133",
  "locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1",
  "displayName": "John Andersen",
  "firstName": "John",
  "lastName": "Andersen",
  "avatar": "https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600",
  "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
  "roles": [
    "Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
    "Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
  ],
  "licenses": [
    "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
    "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
  ]
}
200 / OK
{
  "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
  "emails": [
    "john.andersen@example.com"
  ],
  "phoneNumbers": [
    {
      "type": "work",
      "value": "+1 408 526 7209"
    }
  ],
  "extension": "133",
  "locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1",
  "displayName": "John Andersen",
  "nickName": "John",
  "firstName": "John",
  "lastName": "Andersen",
  "avatar": "https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600",
  "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
  "roles": [
    "Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
    "Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
  ],
  "licenses": [
    "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
    "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
  ],
  "created": "2015-10-18T14:26:16.000Z",
  "lastModified": "2015-10-18T14:26:16.000Z",
  "timezone": "America/Denver",
  "lastActivity": "2015-10-18T14:26:16.028Z",
  "status": "active",
  "invitePending": "false",
  "loginEnabled": "true",
  "type": "person"
}