openapi: 3.0.0 info: title: Webex Admin Address Book Journey - Subscription API API version: 1.0.0 description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling. tags: - name: Journey - Subscription API paths: /admin/v1/api/wxcc-subscription/workspace-id/{workspaceId}: get: tags: - Journey - Subscription API summary: Get WXCC Subscription description: Get WXCC Subscription in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes operationId: getWXCCSubscription parameters: - name: workspaceId in: path description: Workspace ID required: true schema: type: string example: 6377dafe02e7cc19b03a71b7 responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/WXCCSubscriptionResponseList' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ApiError404' '409': description: Resource already exists content: application/json: schema: $ref: '#/components/schemas/ApiError409' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/ApiError429' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ApiError500' security: - bearerAuth: [] post: tags: - Journey - Subscription API summary: Create WXCC Subscription description: Create WXCC Subscription in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_write or cjp:config_write scopes operationId: createWXCCSubscription parameters: - name: workspaceId in: path description: Workspace ID required: true schema: type: string example: 6377dafe02e7cc19b03a71b7 responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/WXCCSubscriptionResponseList' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ApiError404' '409': description: Resource already exists content: application/json: schema: $ref: '#/components/schemas/ApiError409' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/ApiError429' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ApiError500' security: - bearerAuth: [] delete: tags: - Journey - Subscription API summary: Delete WXCC Subscription description: Delete WXCC Subscription in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_write or cjp:config_write scopes operationId: deleteWXCCSubscription parameters: - name: workspaceId in: path description: Workspace ID required: true schema: type: string example: 6377dafe02e7cc19b03a71b7 responses: '200': description: No Content content: application/json: schema: type: string '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ApiError404' '409': description: Resource already exists content: application/json: schema: $ref: '#/components/schemas/ApiError409' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/ApiError429' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ApiError500' security: - bearerAuth: [] components: schemas: ApiError409: required: - trackingId type: object properties: status: type: string description: Http Status Description example: 409 CONFLICT enum: - 100 CONTINUE - 101 SWITCHING_PROTOCOLS - 102 PROCESSING - 103 EARLY_HINTS - 103 CHECKPOINT - 200 OK - 201 CREATED - 202 ACCEPTED - 203 NON_AUTHORITATIVE_INFORMATION - 204 NO_CONTENT - 205 RESET_CONTENT - 206 PARTIAL_CONTENT - 207 MULTI_STATUS - 208 ALREADY_REPORTED - 226 IM_USED - 300 MULTIPLE_CHOICES - 301 MOVED_PERMANENTLY - 302 FOUND - 302 MOVED_TEMPORARILY - 303 SEE_OTHER - 304 NOT_MODIFIED - 305 USE_PROXY - 307 TEMPORARY_REDIRECT - 308 PERMANENT_REDIRECT - 400 BAD_REQUEST - 401 UNAUTHORIZED - 402 PAYMENT_REQUIRED - 403 FORBIDDEN - 404 NOT_FOUND - 405 METHOD_NOT_ALLOWED - 406 NOT_ACCEPTABLE - 407 PROXY_AUTHENTICATION_REQUIRED - 408 REQUEST_TIMEOUT - 409 CONFLICT - 410 GONE - 411 LENGTH_REQUIRED - 412 PRECONDITION_FAILED - 413 PAYLOAD_TOO_LARGE - 413 REQUEST_ENTITY_TOO_LARGE - 414 URI_TOO_LONG - 414 REQUEST_URI_TOO_LONG - 415 UNSUPPORTED_MEDIA_TYPE - 416 REQUESTED_RANGE_NOT_SATISFIABLE - 417 EXPECTATION_FAILED - 418 I_AM_A_TEAPOT - 419 INSUFFICIENT_SPACE_ON_RESOURCE - 420 METHOD_FAILURE - 421 DESTINATION_LOCKED - 422 UNPROCESSABLE_ENTITY - 423 LOCKED - 424 FAILED_DEPENDENCY - 425 TOO_EARLY - 426 UPGRADE_REQUIRED - 428 PRECONDITION_REQUIRED - 429 TOO_MANY_REQUESTS - 431 REQUEST_HEADER_FIELDS_TOO_LARGE - 451 UNAVAILABLE_FOR_LEGAL_REASONS - 500 INTERNAL_SERVER_ERROR - 501 NOT_IMPLEMENTED - 502 BAD_GATEWAY - 503 SERVICE_UNAVAILABLE - 504 GATEWAY_TIMEOUT - 505 HTTP_VERSION_NOT_SUPPORTED - 506 VARIANT_ALSO_NEGOTIATES - 507 INSUFFICIENT_STORAGE - 508 LOOP_DETECTED - 509 BANDWIDTH_LIMIT_EXCEEDED - 510 NOT_EXTENDED - 511 NETWORK_AUTHENTICATION_REQUIRED message: type: string description: Error Message example: Resource Already Exists errors: type: array description: Resource Already Exists example: - Id 3249892348-sdfjsdhf-345hdsf-345345 already exists items: type: string timestamp: type: string description: Occurred timestamp format: date-time example: '2023-03-27T20:59:32.376Z' trackingId: type: string description: Unique ID by which a request can be debugged. Please provide if opening a support case. example: 76cd71d0e678a8bb ApiError429: required: - trackingId type: object properties: status: type: string description: Http Status Description example: 429 TOO_MANY_REQUESTS enum: - 100 CONTINUE - 101 SWITCHING_PROTOCOLS - 102 PROCESSING - 103 EARLY_HINTS - 103 CHECKPOINT - 200 OK - 201 CREATED - 202 ACCEPTED - 203 NON_AUTHORITATIVE_INFORMATION - 204 NO_CONTENT - 205 RESET_CONTENT - 206 PARTIAL_CONTENT - 207 MULTI_STATUS - 208 ALREADY_REPORTED - 226 IM_USED - 300 MULTIPLE_CHOICES - 301 MOVED_PERMANENTLY - 302 FOUND - 302 MOVED_TEMPORARILY - 303 SEE_OTHER - 304 NOT_MODIFIED - 305 USE_PROXY - 307 TEMPORARY_REDIRECT - 308 PERMANENT_REDIRECT - 400 BAD_REQUEST - 401 UNAUTHORIZED - 402 PAYMENT_REQUIRED - 403 FORBIDDEN - 404 NOT_FOUND - 405 METHOD_NOT_ALLOWED - 406 NOT_ACCEPTABLE - 407 PROXY_AUTHENTICATION_REQUIRED - 408 REQUEST_TIMEOUT - 409 CONFLICT - 410 GONE - 411 LENGTH_REQUIRED - 412 PRECONDITION_FAILED - 413 PAYLOAD_TOO_LARGE - 413 REQUEST_ENTITY_TOO_LARGE - 414 URI_TOO_LONG - 414 REQUEST_URI_TOO_LONG - 415 UNSUPPORTED_MEDIA_TYPE - 416 REQUESTED_RANGE_NOT_SATISFIABLE - 417 EXPECTATION_FAILED - 418 I_AM_A_TEAPOT - 419 INSUFFICIENT_SPACE_ON_RESOURCE - 420 METHOD_FAILURE - 421 DESTINATION_LOCKED - 422 UNPROCESSABLE_ENTITY - 423 LOCKED - 424 FAILED_DEPENDENCY - 425 TOO_EARLY - 426 UPGRADE_REQUIRED - 428 PRECONDITION_REQUIRED - 429 TOO_MANY_REQUESTS - 431 REQUEST_HEADER_FIELDS_TOO_LARGE - 451 UNAVAILABLE_FOR_LEGAL_REASONS - 500 INTERNAL_SERVER_ERROR - 501 NOT_IMPLEMENTED - 502 BAD_GATEWAY - 503 SERVICE_UNAVAILABLE - 504 GATEWAY_TIMEOUT - 505 HTTP_VERSION_NOT_SUPPORTED - 506 VARIANT_ALSO_NEGOTIATES - 507 INSUFFICIENT_STORAGE - 508 LOOP_DETECTED - 509 BANDWIDTH_LIMIT_EXCEEDED - 510 NOT_EXTENDED - 511 NETWORK_AUTHENTICATION_REQUIRED message: type: string description: Error Message example: Too many requests errors: type: array description: Too many requests example: - Too many requests items: type: string timestamp: type: string description: Occurred timestamp format: date-time example: '2023-03-27T20:59:32.376Z' trackingId: type: string description: Unique ID by which a request can be debugged. Please provide if opening a support case. example: 76cd71d0e678a8bb WXCCSubscriptionResponseModel: required: - createdTime - description - destinationUrl - eventTypes - id - lastUpdatedTime - name - status type: object properties: id: type: string description: Subscription ID example: 1eb65fdf-9643-417f-9974-ad72cae0e10f name: type: string description: Subscription Name example: CareHybrid WXCC Subscription description: type: string description: Subscription Description example: This is for carehybrid subscription eventTypes: type: array description: Event Types to be subscribed example: - task:* - agent:* items: type: string destinationUrl: type: string description: Destination URL example: https://uswest-nonprod.cjaas.cisco.com/events/v1/journey/wxcc-callback createdTime: type: integer description: Created Time format: int64 example: 1669165699 status: type: string description: Status example: active lastUpdatedTime: type: integer description: Last Updated Time format: int64 example: 1669165699 description: WXCC Subscription Response Model ApiError500: required: - trackingId type: object properties: status: type: string description: Http Status Description example: 500 INTERNAL_SERVER_ERROR enum: - 100 CONTINUE - 101 SWITCHING_PROTOCOLS - 102 PROCESSING - 103 EARLY_HINTS - 103 CHECKPOINT - 200 OK - 201 CREATED - 202 ACCEPTED - 203 NON_AUTHORITATIVE_INFORMATION - 204 NO_CONTENT - 205 RESET_CONTENT - 206 PARTIAL_CONTENT - 207 MULTI_STATUS - 208 ALREADY_REPORTED - 226 IM_USED - 300 MULTIPLE_CHOICES - 301 MOVED_PERMANENTLY - 302 FOUND - 302 MOVED_TEMPORARILY - 303 SEE_OTHER - 304 NOT_MODIFIED - 305 USE_PROXY - 307 TEMPORARY_REDIRECT - 308 PERMANENT_REDIRECT - 400 BAD_REQUEST - 401 UNAUTHORIZED - 402 PAYMENT_REQUIRED - 403 FORBIDDEN - 404 NOT_FOUND - 405 METHOD_NOT_ALLOWED - 406 NOT_ACCEPTABLE - 407 PROXY_AUTHENTICATION_REQUIRED - 408 REQUEST_TIMEOUT - 409 CONFLICT - 410 GONE - 411 LENGTH_REQUIRED - 412 PRECONDITION_FAILED - 413 PAYLOAD_TOO_LARGE - 413 REQUEST_ENTITY_TOO_LARGE - 414 URI_TOO_LONG - 414 REQUEST_URI_TOO_LONG - 415 UNSUPPORTED_MEDIA_TYPE - 416 REQUESTED_RANGE_NOT_SATISFIABLE - 417 EXPECTATION_FAILED - 418 I_AM_A_TEAPOT - 419 INSUFFICIENT_SPACE_ON_RESOURCE - 420 METHOD_FAILURE - 421 DESTINATION_LOCKED - 422 UNPROCESSABLE_ENTITY - 423 LOCKED - 424 FAILED_DEPENDENCY - 425 TOO_EARLY - 426 UPGRADE_REQUIRED - 428 PRECONDITION_REQUIRED - 429 TOO_MANY_REQUESTS - 431 REQUEST_HEADER_FIELDS_TOO_LARGE - 451 UNAVAILABLE_FOR_LEGAL_REASONS - 500 INTERNAL_SERVER_ERROR - 501 NOT_IMPLEMENTED - 502 BAD_GATEWAY - 503 SERVICE_UNAVAILABLE - 504 GATEWAY_TIMEOUT - 505 HTTP_VERSION_NOT_SUPPORTED - 506 VARIANT_ALSO_NEGOTIATES - 507 INSUFFICIENT_STORAGE - 508 LOOP_DETECTED - 509 BANDWIDTH_LIMIT_EXCEEDED - 510 NOT_EXTENDED - 511 NETWORK_AUTHENTICATION_REQUIRED message: type: string description: Error Message example: Internal server error errors: type: array description: Internal server error example: - 'Internal server error ' items: type: string timestamp: type: string description: Occurred timestamp format: date-time example: '2023-03-27T20:59:32.376Z' trackingId: type: string description: Unique ID by which a request can be debugged. Please provide if opening a support case. example: 76cd71d0e678a8bb ApiError404: required: - trackingId type: object properties: status: type: string description: Http Status Description example: 404 NOT_FOUND enum: - 100 CONTINUE - 101 SWITCHING_PROTOCOLS - 102 PROCESSING - 103 EARLY_HINTS - 103 CHECKPOINT - 200 OK - 201 CREATED - 202 ACCEPTED - 203 NON_AUTHORITATIVE_INFORMATION - 204 NO_CONTENT - 205 RESET_CONTENT - 206 PARTIAL_CONTENT - 207 MULTI_STATUS - 208 ALREADY_REPORTED - 226 IM_USED - 300 MULTIPLE_CHOICES - 301 MOVED_PERMANENTLY - 302 FOUND - 302 MOVED_TEMPORARILY - 303 SEE_OTHER - 304 NOT_MODIFIED - 305 USE_PROXY - 307 TEMPORARY_REDIRECT - 308 PERMANENT_REDIRECT - 400 BAD_REQUEST - 401 UNAUTHORIZED - 402 PAYMENT_REQUIRED - 403 FORBIDDEN - 404 NOT_FOUND - 405 METHOD_NOT_ALLOWED - 406 NOT_ACCEPTABLE - 407 PROXY_AUTHENTICATION_REQUIRED - 408 REQUEST_TIMEOUT - 409 CONFLICT - 410 GONE - 411 LENGTH_REQUIRED - 412 PRECONDITION_FAILED - 413 PAYLOAD_TOO_LARGE - 413 REQUEST_ENTITY_TOO_LARGE - 414 URI_TOO_LONG - 414 REQUEST_URI_TOO_LONG - 415 UNSUPPORTED_MEDIA_TYPE - 416 REQUESTED_RANGE_NOT_SATISFIABLE - 417 EXPECTATION_FAILED - 418 I_AM_A_TEAPOT - 419 INSUFFICIENT_SPACE_ON_RESOURCE - 420 METHOD_FAILURE - 421 DESTINATION_LOCKED - 422 UNPROCESSABLE_ENTITY - 423 LOCKED - 424 FAILED_DEPENDENCY - 425 TOO_EARLY - 426 UPGRADE_REQUIRED - 428 PRECONDITION_REQUIRED - 429 TOO_MANY_REQUESTS - 431 REQUEST_HEADER_FIELDS_TOO_LARGE - 451 UNAVAILABLE_FOR_LEGAL_REASONS - 500 INTERNAL_SERVER_ERROR - 501 NOT_IMPLEMENTED - 502 BAD_GATEWAY - 503 SERVICE_UNAVAILABLE - 504 GATEWAY_TIMEOUT - 505 HTTP_VERSION_NOT_SUPPORTED - 506 VARIANT_ALSO_NEGOTIATES - 507 INSUFFICIENT_STORAGE - 508 LOOP_DETECTED - 509 BANDWIDTH_LIMIT_EXCEEDED - 510 NOT_EXTENDED - 511 NETWORK_AUTHENTICATION_REQUIRED message: type: string description: Error Message example: Resource not found errors: type: array description: Resource Already Found example: - Id 3249892348-sdfjsdhf-345hdsf-345345 Not Found items: type: string timestamp: type: string description: Occurred timestamp format: date-time example: '2023-03-27T20:59:32.376Z' trackingId: type: string description: Unique ID by which a request can be debugged. Please provide if opening a support case. example: 76cd71d0e678a8bb WXCCSubscriptionResponseList: type: object properties: meta: $ref: '#/components/schemas/BaseMetaResponseEnvelope' data: type: array description: Data part of the response items: $ref: '#/components/schemas/WXCCSubscriptionResponseModel' BaseMetaResponseEnvelope: type: object properties: organizationId: type: string description: Organization ID example: 1eb65fdf-9643-417f-9974-ad72cae0e10f description: Meta information of the response example: organizationId: 1eb65fdf-9643-417f-9974-ad72cae0e10f securitySchemes: oauth2: flows: authorizationCode: authorizationUrl: / scopes: {} tokenUrl: / type: oauth2 bearer-key: type: http description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN scheme: bearer bearerFormat: JWT bearerAuth: type: oauth2 description: OAuth 2.0 Bearer token authentication flows: authorizationCode: authorizationUrl: https://webexapis.com/v1/authorize tokenUrl: https://webexapis.com/v1/access_token scopes: spark:applications_token: Create access tokens for Service Apps