DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Getting StartedPlatform Introduction
Embedded Apps
OverviewDeveloper GuideSidebar API Quick StartSubmission Checklist for Embedded Apps
Design Guidelines
MessagingMeetingsDevicesSidebar
API Reference
BotsButtons and CardsIntegrationsService AppsLogin with WebexGuest IssuerWidgetsWebex ConnectInstant Connect Meeting LinksDeveloper SandboxSubmit Your AppSupport PolicyFAQs
APIs
API Behavior ChangesXML API DeprecationAccess the APIREST API BasicsComplianceWebhooksWebex APIs
Admin
OverviewAdmin APIsAuthentication
Guides
Hybrid ServicesWebhooksReal-time File DLP BasicsUsing Webex Service AppsProvisioning APIsAudit Events Error Reference
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesMeeting QualitiesOrganization ContactsOrganizationsPartner ManagementPartner TagsPeople
GETList People
POSTCreate a Person
GETGet Person Details
PUTUpdate a Person
DELETEDelete a Person
GETGet My Own Details
Recording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSecurity Audit EventsSession TypesSpace ClassificationsTracking CodesWorkspace LocationsWorkspace Metrics
Webex Calling Beta
Overview
Guides
Integrations and Authorization
Webex Calling
OverviewSDKs and ToolsWhat's New
Guides
Integrations and AuthorizationProvisioning APIsWebex for Wholesale
Reference
Call ControlsCall RoutingCalling Service SettingsDECT Devices SettingsDevice Call SettingsDevicesFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Hunt GroupFeatures: Paging GroupLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsNumbersPeople
GETList People
POSTCreate a Person
GETGet Person Details
PUTUpdate a Person
DELETEDelete a Person
GETGet My Own Details
Recording ReportReportsReports: Detailed Call HistoryUser Call SettingsVirtual Line Call SettingsWholesale Billing ReportsWholesale ProvisioningWorkspace Call SettingsWorkspaces
Webex for Broadworks
Overview
Guides
Integrations and AuthorizationWholesale and Broadworks Common GuideDeveloper's Guide
Reference
BroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks Workspaces
Webex for UCM
Guides
Integrations and Authorization
Reference
UCM Profile
Contact Center
Overview
Customer Journey Data
Overview
Guides
Getting StartedFAQ
Devices
Overview
Guides
Devices
Reference
Device Call SettingsDevice ConfigurationsDevicesWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Meetings
Overview
Guides
Integrations and AuthorizationWebhooksUsing Webex Service AppsWebinar GuideMeeting Resource Guide
Reference
Meeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportPeople
GETList People
POSTCreate a Person
GETGet Person Details
PUTUpdate a Person
DELETEDelete a Person
GETGet My Own Details
Recording ReportRecordingsSession TypesTracking CodesVideo MeshWebhooks
Messaging
Overview
Guides
BotsIntegrations and AuthorizationWebhooksUsing Webex Service AppsButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeople
GETList People
POSTCreate a Person
GETGet Person Details
PUTUpdate a Person
DELETEDelete a Person
GETGet My Own Details
Room TabsRoomsTeam MembershipsTeamsTracking CodesWebhooks
Webex Assistant Skills
Overview
Guides
Skills SDK GuideSkills Developer PortalSkills Reference GuideSkills UX Guide
FedRAMP
Overview
Guides
Create a BotCreate an IntegrationNotes on API Support
Workspace Integrations
OverviewTechnical DetailsControl Hub Features
Webex Status API
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks WorkspacesCall ControlsCall RoutingCalling Service SettingsDECT Devices SettingsDevice Call SettingsDevice ConfigurationsDevicesEventsFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Hunt GroupFeatures: Paging GroupGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportMembershipsMessagesNumbersOrganization ContactsOrganizationsPartner ManagementPartner TagsPeople
GETList People
POSTCreate a Person
GETGet Person Details
PUTUpdate a Person
DELETEDelete a Person
GETGet My Own Details
Recording ReportRecordingsReport TemplatesReportsReports: Detailed Call HistoryResource Group MembershipsResource GroupsRolesRoom TabsRoomsSecurity Audit EventsSession TypesSiteSpace ClassificationsTeam MembershipsTeamsTracking CodesUCM ProfileUser Call SettingsVideo MeshVirtual Line Call SettingsWebhooksWholesale Billing ReportsWholesale ProvisioningWorkspace Call SettingsWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
iOSAndroidBrowserNode.jsJava
Developer CommunityCertifications

Create a Person

Create a new user account for a given organization. Only an admin can create a new user account.

At least one of the following body parameters is required to create a new user: displayName, firstName, lastName.

Currently, users may have only one email address associated with their account. The emails parameter is an array, which accepts multiple values to allow for future expansion, but currently only one email address will be used for the new user.

Admin users can include Webex calling (BroadCloud) user details in the response by specifying callingData parameter as true. It may happen that the POST request with calling data returns a 400 status, but the person was created still. One way to get into this state is if an invalid phone number is assigned to a user. The people API aggregates calls to several other microservices, and one may have failed. A best practice is to check if the user exists before retrying. This can be done with the user's email address and a GET /people.

When doing attendee management, append #attendee to the siteUrl parameter (e.g. mysite.webex.com#attendee) to make the new user an attendee for a site.

NOTE:

  • For creating a Webex Calling user, you must provide phoneNumbers or extension, locationId, and licenses string in the same request.
POST/v1/people
Query Parameters
callingData
boolean

Include Webex Calling user details in the response.

Default: false
Body Parameters
emails
array[string]required

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

Possible values: john.andersen@example.com
phoneNumbers
array[object]

Phone numbers for the person. Only settable for Webex Calling. Requires a Webex Calling license.

type
enum

The type of phone number.

work
string
value
string

The phone number.

Possible values: 408 526 7209
extension
string

Webex Calling extension of the person. This is only settable for a person with a Webex Calling license.

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[string]

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

Possible values: Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh, Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi
licenses
array[string]

An array of license strings allocated to this person.

Possible values: Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh, Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi
department
string

The business department the user belongs to.

manager
string

A manager identifier.

managerId
string

Person Id of the manager

title
string

the person's title

addresses
array[object]

Person's address

type
string

The type of address

Possible values: work
country
string

The user's country

Possible values: US
locality
string

the user's locality, often city

Possible values: Milpitas
region
string

the user's region, often state

Possible values: California
streetAddress
string

the user's street

Possible values: 1099 Bird Ave.
postalCode
string

the user's postal or zip code

Possible values: 99212
siteUrls
array[string]

One or several site names where this user has an attendee role. Append #attendee to the sitename (eg: mysite.webex.com#attendee)

Possible values: mysite.webex.com#attendee
Response Properties
id
string

A unique identifier for the person.

emails
array[string]

The email addresses of the person.

phoneNumbers
array[object]

Phone numbers for the person.

type
enum

The type of phone number.

work
string

Work phone number of the person.

work_extension
string

Work extension of the person. For the Webex Calling person, the value will have a routing prefix along with the extension.

mobile
string

Mobile number of the person.

fax
string

FAX number of the person.

value
string

The phone number.

Possible values: +1 408 526 7209
extension
string

The Webex Calling extension for the person. Only applies to a person with a Webex Calling license

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[string]

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

licenses
array[string]

An array of license strings allocated to this person.

department
string

The business department the user belongs to.

manager
string

A manager identifier

managerId
string

Person Id of the manager

title
string

the person's title

addresses
array[object]

Person's address

type
string

The type of address

Possible values: work
country
string

The user's country

Possible values: US
locality
string

the user's locality, often city

Possible values: Milpitas
region
string

the user's region, often state

Possible values: California
streetAddress
string

the user's street

Possible values: 1099 Bird Ave.
postalCode
string

the user's postal or zip code

Possible values: 99212
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. 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.

siteUrls
array[string]

One or several site names where this user has a role (host or attendee)

sipAddresses
array[{"type": "personal-room","value": "testuser5@mycompany.webex.com","primary": false}]

The users sip addresses. Read-only.

xmppFederationJid
string

Identifier for intra-domain federation with other XMPP based messenger systems.

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
string

Active within the last 10 minutes

call
string

The user is in a call

DoNotDisturb
string

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

inactive
string

Last activity occurred more than 10 minutes ago

meeting
string

The user is in a meeting

OutOfOffice
string

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

pending
string

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

presenting
string

The user is sharing content

unknown
string

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
string

The person has been invited to Webex but has not created an account

false
string

An invite is not pending for this person

loginEnabled
enum

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

true
string

the person can log into Webex

false
string

the person cannot log into Webex

type
enum

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

person
string

Account belongs to a person

bot
string

Account is a bot user

appuser
string

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.
201CreatedThe request has succeeded and has led to the creation of a resource.
202AcceptedThe request has been accepted for processing.
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.
  • Try it
  • Example
POST
/v1/people{?callingData}
Log in to try the API.
Header
Query Parameters
  • Include Webex Calling 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. Only settable for Webex Calling. Requires a Webex Calling license.
  • Webex Calling extension of the person. This is only settable for a person with a Webex Calling license.
  • 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 admin user belongs.
  • An array of license strings allocated to this person.
  • The business department the user belongs to.
  • A manager identifier.
  • Person Id of the manager
  • the person's title
  • Person's address
  • One or several site names where this user has an attendee role. Append `#attendee` to the sitename (eg: mysite.webex.com#attendee)
  • Request
  • Response
https://webexapis.com/v1/people?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"
  ],
  "department": "Sales",
  "manager": "John Duarte",
  "managerId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80ZGEzYTI0OC05YjBhLTQxMDgtODU0NC1iNTQwMzEyZTU2M2E",
  "title": "GM",
  "addresses": [
    {
      "type": "work",
      "country": "US",
      "locality": "Milpitas",
      "region": "California",
      "streetAddress": "1099 Bird Ave.",
      "postalCode": "99212"
    }
  ],
  "siteUrls": [
    "mysite.webex.com#attendee"
  ]
}
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"
  ],
  "department": "Sales",
  "manager": "John Duarte",
  "managerId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80ZGEzYTI0OC05YjBhLTQxMDgtODU0NC1iNTQwMzEyZTU2M2E",
  "title": "GM",
  "addresses": [
    {
      "type": "work",
      "country": "US",
      "locality": "Milpitas",
      "region": "California",
      "streetAddress": "1099 Bird Ave.",
      "postalCode": "99212"
    }
  ],
  "created": "2015-10-18T14:26:16.000Z",
  "lastModified": "2015-10-18T14:26:16.000Z",
  "timezone": "America/Denver",
  "lastActivity": "2015-10-18T14:26:16.028Z",
  "siteUrls": [
    "mysite.webex.com#attendee"
  ],
  "sipAddresses": [
    {}
  ],
  "xmppFederationJid": "user@example.com",
  "status": "active",
  "invitePending": "false",
  "loginEnabled": "true",
  "type": "person"
}

Connect

Support

Developer Community

Developer Events

Contact Sales

Handy Links

Webex Ambassadors

Webex App Hub

Resources

Open Source Bot Starter Kits

Download Webex

DevNet Learning Labs

Terms of Service

Privacy Policy

Cookie Policy

Trademarks

© 2023 Cisco and/or its affiliates. All rights reserved.