Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Webex Journey - Customer Identification API API

The Journey - Customer Identification API API from Webex — 7 operation(s) for journey - customer identification api.

Webex Journey - Customer Identification API API is one of 178 APIs that Webex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Journey - Customer Identification API. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 9 operations across 7 paths, and defines 14 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

9 operations 7 paths 14 schemas 1 DELETE2 GET3 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Authentication
OAuth 2.0, HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 3

Webex Journey - Customer Identification API API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (bearer-key). It supports OAuth 2.0 (bearerAuth) using the authorizationCode flow, exposing 1 scope.

  • bearer-key — e.g. Bearer YOURAUTHORIZATIONTOKEN
  • bearerAuth — OAuth 2.0 Bearer token authentication

Paths & Operations 9

Across 7 paths, the API surfaces 9 operations — 1 DELETE, 2 GET, 3 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Journey - Customer Identification API 9
DELETE
/admin/v1/api/person/workspace-id/{workspaceId}/person-id/{personId}
Delete specific Person by id
deletePersonbyId 2 params → 200404500
PATCH
/admin/v1/api/person/workspace-id/{workspaceId}/person-id/{personId}
Add/Remove/Replace details of a Person
addRemoveAliases 2 params body → 202400404500
PATCH
/admin/v1/api/person/add-identities/workspace-id/{workspaceId}/person-id/{personId}
Add one/more Identities to a person
addIdentitiesToPerson 2 params body → 200400401404500
PATCH
/admin/v1/api/person/remove-identities/workspace-id/{workspaceId}/person-id/{personId}
Remove one/more Identities from a person
removeIdentitiesFromPerson 2 params body → 200400401404500
GET
/admin/v1/api/person/workspace-id/{workspaceId}
Get all or a specific Person Details
getPersonDetails 7 params → 200404500
POST
/admin/v1/api/person/workspace-id/{workspaceId}
Create a Person
createPerson 1 param body → 201400404500
POST
/admin/v1/api/person/merge/workspace-id/{workspaceId}/primary-person-id/{primaryPersonId}
Merges Identities to a Primary Identity
mergeAliases 2 params body → 202400404500
POST
/admin/v1/api/person/merge-identities/workspace-id/{workspaceId}
Creates or merges aliases to an Individual in JDS
mergeIdentities 1 param body → 200400404500
GET
/admin/v1/api/person/workspace-id/{workspaceId}/aliases/{aliases}
Search for an Identity via aliases
getPersonbyAliases 6 params → 200404500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are PersonResponseModel (8 properties), MergePersonRequestModel (8 properties), CreateOrUpdatePersonRequestModel (6 properties), ApiError400 (5 properties). Each schema is shown below with its type and property counts.

PersonResponseModel
object
Person Response Model
8 properties
ApiError401
object
5 properties 1 required
ApiError400
object
5 properties 1 required
PersonResponse
object
2 properties
PatchRequest
array
ApiError500
object
5 properties 1 required
ApiError404
object
5 properties 1 required
MergePersonRequestModel
object
Merge Person
8 properties
CreateOrUpdatePersonRequestModel
object
Create Or Update Person
6 properties
BaseMetaResponseEnvelope
object
Meta information of the response
1 property
PersonGetResponse
object
2 properties
PatchDocument
object
A JSONPatch document as defined by RFC 6902
3 properties 2 required
AddIdentitiesToPersonRequestModel
object
Add Identities to Person
4 properties
MergePersonsRequest
object
Merge two or more persons
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-journey-customer-identification-api-api-openapi.yml Raw ↑

Other APIs Webex publishes across the network.

Webex Address Book API
Webex Admin Audit Events API
Webex Agent Personal Greeting Files API
Webex Agent Summaries API
Webex Agent Wellbeing API
Webex Agents API
Webex AI Feature API
Webex API - Domain Management API
Webex Archive Users API
Webex Attachment Actions API
Webex Audio Files API
Webex Authorizations API