Webex Contact Center — Journey - Customer Identification API

naftiko: 1.0.0-alpha2
info:
  label: Webex Contact Center — Journey - Customer Identification API
  description: 'Webex Contact Center — Journey - Customer Identification API. 9 operations. Lead operation: Add one/more Identities
    to a person. Self-contained Naftiko capability covering one Webex business surface.'
  tags:
  - Webex
  - Journey - Customer Identification API
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WEBEX_API_KEY: WEBEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: contact-center-journey-customer-identification-api
    baseUri: ''
    description: Webex Contact Center — Journey - Customer Identification API business capability. Self-contained, no shared
      references.
    resources:
    - name: admin-v1-api-person-add-identities-workspace-id-workspaceId-person-id-personId
      path: /admin/v1/api/person/add-identities/workspace-id/{workspaceId}/person-id/{personId}
      operations:
      - name: addidentitiestoperson
        method: PATCH
        description: Add one/more Identities to a person
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspaceId
          in: path
          type: string
          description: Workspace ID
          required: true
        - name: personId
          in: path
          type: string
          description: Person ID
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: admin-v1-api-person-merge-identities-workspace-id-workspaceId
      path: /admin/v1/api/person/merge-identities/workspace-id/{workspaceId}
      operations:
      - name: mergeidentities
        method: POST
        description: Creates or merges aliases to an Individual in JDS
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspaceId
          in: path
          type: string
          description: Workspace ID
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: admin-v1-api-person-merge-workspace-id-workspaceId-primary-person-id-primaryPers
      path: /admin/v1/api/person/merge/workspace-id/{workspaceId}/primary-person-id/{primaryPersonId}
      operations:
      - name: mergealiases
        method: POST
        description: Merges Identities to a Primary Identity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspaceId
          in: path
          type: string
          description: Workspace ID
          required: true
        - name: primaryPersonId
          in: path
          type: string
          description: Primary Person ID
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: admin-v1-api-person-remove-identities-workspace-id-workspaceId-person-id-personI
      path: /admin/v1/api/person/remove-identities/workspace-id/{workspaceId}/person-id/{personId}
      operations:
      - name: removeidentitiesfromperson
        method: PATCH
        description: Remove one/more Identities from a person
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspaceId
          in: path
          type: string
          description: Workspace ID
          required: true
        - name: personId
          in: path
          type: string
          description: Person ID
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: admin-v1-api-person-workspace-id-workspaceId
      path: /admin/v1/api/person/workspace-id/{workspaceId}
      operations:
      - name: getpersondetails
        method: GET
        description: Get all or a specific Person Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspaceId
          in: path
          type: string
          description: Workspace ID
          required: true
        - name: personId
          in: query
          type: string
          description: Person ID
        - name: filter
          in: query
          type: string
          description: 'Optional filter which can be applied to the elements to be fetched. '
        - name: sortBy
          in: query
          type: string
          description: Sort By Field
        - name: sort
          in: query
          type: string
          description: Sort direction
        - name: page
          in: query
          type: integer
          description: Index of the page of results to be fetched.
        - name: pageSize
          in: query
          type: integer
          description: Number of items to be displayed on a page
      - name: createperson
        method: POST
        description: Create a Person
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspaceId
          in: path
          type: string
          description: Workspace ID
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: admin-v1-api-person-workspace-id-workspaceId-aliases-aliases
      path: /admin/v1/api/person/workspace-id/{workspaceId}/aliases/{aliases}
      operations:
      - name: getpersonbyaliases
        method: GET
        description: Search for an Identity via aliases
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspaceId
          in: path
          type: string
          description: Workspace ID
          required: true
        - name: aliases
          in: path
          type: string
          description: 'Aliases to search for. Multiple aliases should be separated by a comma. '
          required: true
        - name: sortBy
          in: query
          type: string
          description: Sort By Field
        - name: sort
          in: query
          type: string
          description: Sort direction
        - name: page
          in: query
          type: integer
          description: Index of the page of results to be fetched.
        - name: pageSize
          in: query
          type: integer
          description: Number of items to be displayed on a page.
    - name: admin-v1-api-person-workspace-id-workspaceId-person-id-personId
      path: /admin/v1/api/person/workspace-id/{workspaceId}/person-id/{personId}
      operations:
      - name: deletepersonbyid
        method: DELETE
        description: Delete specific Person by id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspaceId
          in: path
          type: string
          description: Workspace ID
          required: true
        - name: personId
          in: path
          type: string
          description: Person ID
          required: true
      - name: addremovealiases
        method: PATCH
        description: Add/Remove/Replace details of a Person
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspaceId
          in: path
          type: string
          description: Workspace ID
          required: true
        - name: personId
          in: path
          type: string
          description: Person ID
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.WEBEX_API_KEY}}'
  exposes:
  - type: rest
    namespace: contact-center-journey-customer-identification-api-rest
    port: 8080
    description: REST adapter for Webex Contact Center — Journey - Customer Identification API. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/admin/v1/api/person/add-identities/workspace-id/{workspaceid}/person-id/{personid}
      name: admin-v1-api-person-add-identities-workspace-id-workspaceid-person-id-personid
      description: REST surface for admin-v1-api-person-add-identities-workspace-id-workspaceId-person-id-personId.
      operations:
      - method: PATCH
        name: addidentitiestoperson
        description: Add one/more Identities to a person
        call: contact-center-journey-customer-identification-api.addidentitiestoperson
        with:
          workspaceId: rest.workspaceId
          personId: rest.personId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/v1/api/person/merge-identities/workspace-id/{workspaceid}
      name: admin-v1-api-person-merge-identities-workspace-id-workspaceid
      description: REST surface for admin-v1-api-person-merge-identities-workspace-id-workspaceId.
      operations:
      - method: POST
        name: mergeidentities
        description: Creates or merges aliases to an Individual in JDS
        call: contact-center-journey-customer-identification-api.mergeidentities
        with:
          workspaceId: rest.workspaceId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/v1/api/person/merge/workspace-id/{workspaceid}/primary-person-id/{primarypersonid}
      name: admin-v1-api-person-merge-workspace-id-workspaceid-primary-person-id-primarypers
      description: REST surface for admin-v1-api-person-merge-workspace-id-workspaceId-primary-person-id-primaryPers.
      operations:
      - method: POST
        name: mergealiases
        description: Merges Identities to a Primary Identity
        call: contact-center-journey-customer-identification-api.mergealiases
        with:
          workspaceId: rest.workspaceId
          primaryPersonId: rest.primaryPersonId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/v1/api/person/remove-identities/workspace-id/{workspaceid}/person-id/{personid}
      name: admin-v1-api-person-remove-identities-workspace-id-workspaceid-person-id-personi
      description: REST surface for admin-v1-api-person-remove-identities-workspace-id-workspaceId-person-id-personI.
      operations:
      - method: PATCH
        name: removeidentitiesfromperson
        description: Remove one/more Identities from a person
        call: contact-center-journey-customer-identification-api.removeidentitiesfromperson
        with:
          workspaceId: rest.workspaceId
          personId: rest.personId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/v1/api/person/workspace-id/{workspaceid}
      name: admin-v1-api-person-workspace-id-workspaceid
      description: REST surface for admin-v1-api-person-workspace-id-workspaceId.
      operations:
      - method: GET
        name: getpersondetails
        description: Get all or a specific Person Details
        call: contact-center-journey-customer-identification-api.getpersondetails
        with:
          workspaceId: rest.workspaceId
          personId: rest.personId
          filter: rest.filter
          sortBy: rest.sortBy
          sort: rest.sort
          page: rest.page
          pageSize: rest.pageSize
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createperson
        description: Create a Person
        call: contact-center-journey-customer-identification-api.createperson
        with:
          workspaceId: rest.workspaceId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/v1/api/person/workspace-id/{workspaceid}/aliases/{aliases}
      name: admin-v1-api-person-workspace-id-workspaceid-aliases-aliases
      description: REST surface for admin-v1-api-person-workspace-id-workspaceId-aliases-aliases.
      operations:
      - method: GET
        name: getpersonbyaliases
        description: Search for an Identity via aliases
        call: contact-center-journey-customer-identification-api.getpersonbyaliases
        with:
          workspaceId: rest.workspaceId
          aliases: rest.aliases
          sortBy: rest.sortBy
          sort: rest.sort
          page: rest.page
          pageSize: rest.pageSize
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/v1/api/person/workspace-id/{workspaceid}/person-id/{personid}
      name: admin-v1-api-person-workspace-id-workspaceid-person-id-personid
      description: REST surface for admin-v1-api-person-workspace-id-workspaceId-person-id-personId.
      operations:
      - method: DELETE
        name: deletepersonbyid
        description: Delete specific Person by id
        call: contact-center-journey-customer-identification-api.deletepersonbyid
        with:
          workspaceId: rest.workspaceId
          personId: rest.personId
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: addremovealiases
        description: Add/Remove/Replace details of a Person
        call: contact-center-journey-customer-identification-api.addremovealiases
        with:
          workspaceId: rest.workspaceId
          personId: rest.personId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: contact-center-journey-customer-identification-api-mcp
    port: 9090
    transport: http
    description: MCP adapter for Webex Contact Center — Journey - Customer Identification API. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: add-one-more-identities-person
      description: Add one/more Identities to a person
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: contact-center-journey-customer-identification-api.addidentitiestoperson
      with:
        workspaceId: tools.workspaceId
        personId: tools.personId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: creates-merges-aliases-individual-jds
      description: Creates or merges aliases to an Individual in JDS
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: contact-center-journey-customer-identification-api.mergeidentities
      with:
        workspaceId: tools.workspaceId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: merges-identities-primary-identity
      description: Merges Identities to a Primary Identity
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: contact-center-journey-customer-identification-api.mergealiases
      with:
        workspaceId: tools.workspaceId
        primaryPersonId: tools.primaryPersonId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: remove-one-more-identities-person
      description: Remove one/more Identities from a person
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: contact-center-journey-customer-identification-api.removeidentitiesfromperson
      with:
        workspaceId: tools.workspaceId
        personId: tools.personId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-all-specific-person-details
      description: Get all or a specific Person Details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: contact-center-journey-customer-identification-api.getpersondetails
      with:
        workspaceId: tools.workspaceId
        personId: tools.personId
        filter: tools.filter
        sortBy: tools.sortBy
        sort: tools.sort
        page: tools.page
        pageSize: tools.pageSize
      outputParameters:
      - type: object
        mapping: $.
    - name: create-person
      description: Create a Person
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: contact-center-journey-customer-identification-api.createperson
      with:
        workspaceId: tools.workspaceId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: search-identity-aliases
      description: Search for an Identity via aliases
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: contact-center-journey-customer-identification-api.getpersonbyaliases
      with:
        workspaceId: tools.workspaceId
        aliases: tools.aliases
        sortBy: tools.sortBy
        sort: tools.sort
        page: tools.page
        pageSize: tools.pageSize
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-specific-person-id
      description: Delete specific Person by id
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: contact-center-journey-customer-identification-api.deletepersonbyid
      with:
        workspaceId: tools.workspaceId
        personId: tools.personId
      outputParameters:
      - type: object
        mapping: $.
    - name: add-remove-replace-details-person
      description: Add/Remove/Replace details of a Person
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: contact-center-journey-customer-identification-api.addremovealiases
      with:
        workspaceId: tools.workspaceId
        personId: tools.personId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.