{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Journey - Customer Identification API API", "version": "1.0.0" }, "items": [ { "info": { "name": "Journey - Customer Identification API", "type": "folder" }, "items": [ { "info": { "name": "Add/Remove/Replace details of a Person", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/person-id/:personId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "personId", "value": "638844db13272c52239c525d", "type": "path", "description": "Person ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The Patch Api can be used to add/remove identities(email, phone, customerId) or replace firstName and lastName of an Individual. We support only add, replace and remove operations. \n\nFor a more information on Patch Requests, see this [JSON PATCH guide](https://jsonpatch.com). \n\nRole and Scope: Requires id full admin role with cjp:config_write or any role with cjp:user or cjp:config_write scope." }, { "info": { "name": "Delete specific Person by id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/person-id/:personId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "personId", "value": "638844db13272c52239c525d", "type": "path", "description": "Person ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete Person Details searched by Person id in JDS. \n\nRole and Scope: Requires id full admin or any role with cjp:config_write scope" }, { "info": { "name": "Add one/more Identities to a person", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/admin/v1/api/person/add-identities/workspace-id/:workspaceId/person-id/:personId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "personId", "value": "638844db13272c52239c525d", "type": "path", "description": "Person ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This Patch Api can be used to add identities(email, phone, customerId) to a person.\n\nRole and Scope: Requires id full admin or any role with cjp:config_write scope." }, { "info": { "name": "Remove one/more Identities from a person", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/admin/v1/api/person/remove-identities/workspace-id/:workspaceId/person-id/:personId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "personId", "value": "638844db13272c52239c525d", "type": "path", "description": "Person ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This Patch Api can be used to remove identities(email, phone, customerId) from a person.\n\nRole and Scope: Requires id full admin or any role with cjp:config_write scope." }, { "info": { "name": "Get all or a specific Person Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "personId", "value": "1eb65fdfsadw34ae0e10f", "type": "query", "description": "Person ID" }, { "name": "filter", "value": "firstName==Ram", "type": "query", "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/documentation/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference)." }, { "name": "sortBy", "value": "firstName", "type": "query", "description": "Sort By Field" }, { "name": "sort", "value": "DESC", "type": "query", "description": "Sort direction" }, { "name": "page", "value": "0", "type": "query", "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve. The page numbering starts with 0." }, { "name": "pageSize", "value": "10", "type": "query", "description": "Number of items to be displayed on a page" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Person Details in JDS. If personId is provided by query parameter, this returns the Person whose personId matches the parameter.\nIf not, this will return ALL the Persons within the organization and workspace. \n\nRole and Scope: Requires id full admin role with cjp:config_write or cjp:config_read scope. Or it requires any role with cjp:user, cjp:config_write or cjp:config_read scope." }, { "info": { "name": "Create a Person", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API helps to create a Person in JDS.\n\nRole and Scope: Requires id full admin OR any role with cjp:config_write scope." }, { "info": { "name": "Merges Identities to a Primary Identity", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/v1/api/person/merge/workspace-id/:workspaceId/primary-person-id/:primaryPersonId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "primaryPersonId", "value": "638844db13272c52239c525d", "type": "path", "description": "Primary Person ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Merges one/more Identities to a **Primary** Individual in JDS. \n\nRole and Scope: Requires id full admin role with cjp:config_write scope." }, { "info": { "name": "Creates or merges aliases to an Individual in JDS", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/v1/api/person/merge-identities/workspace-id/:workspaceId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API enables you to consolidate multiple customer identifiers into a single, unified profile effortlessly. By integrating it with your Flow Designer, you can automatically retrieve and merge customer identifiers from various systems, such as your CRM or other third-party tools. This integration ensures all relevant data is consolidated into one profile, enhancing personalization and streamlining customer interactions. \n\n**Adding a New Alias** - To associate an additional alias (e.g., a new p" }, { "info": { "name": "Search for an Identity via aliases", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/aliases/:aliases", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "aliases", "value": "johndoe@domain1.com,2771154", "type": "path", "description": "Aliases to search for. Multiple aliases should be separated by a comma. \n\n In case the alias(es) contain(s) non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter." }, { "name": "sortBy", "value": "firstName", "type": "query", "description": "Sort By Field" }, { "name": "sort", "value": "DESC", "type": "query", "description": "Sort direction" }, { "name": "page", "value": "0", "type": "query", "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0." }, { "name": "pageSize", "value": "10", "type": "query", "description": "Number of items to be displayed on a page." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get one or more Person Details searched by aliases in JDS. Multiple aliases should be separated by a comma.\n\nRole and Scope: Requires id full admin role with cjp:config_write or cjp:config_read scope. Or it requires any role with cjp:user, cjp:config_write or cjp:config_read scope." } ] } ], "bundled": true }