openapi: 3.0.0
info:
  title: Webex Admin Address Book Attachment Actions 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: Attachment Actions
paths:
  /attachment/actions:
    post:
      responses:
        '202':
          description: Accepted
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttachmentActivity'
              example:
                id: Y2lzY29zcGFyazovL3VzL0NBTExTLzU0MUFFMzBFLUUyQzUtNERENi04NTM4LTgzOTRDODYzM0I3MQo
                personId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZ
                roomId: L3VzL1BFT1BMRS80MDNlZmUwNy02Yzc3LTQyY2UtOWI
                type: submit
                messageId: GFyazovL3VzL1BFT1BMRS80MDNlZmUwNy02Yzc3LTQyY2UtOWI4NC
                inputs:
                  Name: John Andersen
                  Url: https://example.com
                  Email: john.andersen@example.com
                  Tel: +1 408 555 7209
                created: '2016-05-10T19:41:00.100Z'
        '400':
          description: Bad Request
          headers: {}
          content: {}
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: Not Found
          headers: {}
          content: {}
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The 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.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The 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.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too 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.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Create an Attachment Action
      operationId: Create an Attachment Action
      description: Create a new attachment action.
      tags:
      - Attachment Actions
      parameters: []
      requestBody:
        content:
          application/json:
            example:
              type: submit
              messageId: GFyazovL3VzL1BFT1BMRS80MDNlZmUwNy02Yzc3LTQyY2UtOWI4NC
              inputs:
                Name: John Andersen
                Url: https://example.com
                Email: john.andersen@example.com
                Tel: +1 408 555 7209
            schema:
              $ref: '#/components/schemas/SubmitCardAction'
  /attachment/actions/{id}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttachmentActivity'
              example:
                id: Y2lzY29zcGFyazovL3VzL0NBTExTLzU0MUFFMzBFLUUyQzUtNERENi04NTM4LTgzOTRDODYzM0I3MQo
                personId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZ
                roomId: L3VzL1BFT1BMRS80MDNlZmUwNy02Yzc3LTQyY2UtOWI
                type: submit
                messageId: GFyazovL3VzL1BFT1BMRS80MDNlZmUwNy02Yzc3LTQyY2UtOWI4NC
                inputs:
                  Name: John Andersen
                  Url: https://example.com
                  Email: john.andersen@example.com
                  Tel: +1 408 555 7209
                created: '2016-05-10T19:41:00.100Z'
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The 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.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The 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.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The 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.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too 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.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Get Attachment Action Details
      operationId: Get Attachment Action Details
      description: 'Shows details for a attachment action, by ID.


        Specify the attachment action ID in the `id` URI parameter.'
      tags:
      - Attachment Actions
      parameters:
      - name: id
        in: path
        description: A unique identifier for the attachment action.
        required: true
        example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTE
        schema:
          type: string
components:
  schemas:
    SubmitCardAction:
      type: object
      required:
      - type
      - messageId
      - inputs
      properties:
        type:
          type: string
          enum:
          - submit
          description: The type of action to perform.
        messageId:
          type: string
          example: GFyazovL3VzL1BFT1BMRS80MDNlZmUwNy02Yzc3LTQyY2UtOWI4NC
          description: The ID of the message which contains the attachment.
        inputs:
          type: object
          properties:
            Name:
              type: string
              example: John Andersen
            Url:
              type: string
              example: https://example.com
            Email:
              type: string
              example: john.andersen@example.com
            Tel:
              type: string
              example: +1 408 555 7209
          description: The attachment action's inputs.
    AttachmentActivity:
      type: object
      required:
      - type
      - messageId
      properties:
        id:
          type: string
          example: Y2lzY29zcGFyazovL3VzL0NBTExTLzU0MUFFMzBFLUUyQzUtNERENi04NTM4LTgzOTRDODYzM0I3MQo
          description: A unique identifier for the action.
        personId:
          type: string
          example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZ
          description: The ID of the person who performed the action.
        roomId:
          type: string
          example: L3VzL1BFT1BMRS80MDNlZmUwNy02Yzc3LTQyY2UtOWI
          description: The ID of the room in which the action was performed.
        type:
          type: string
          enum:
          - submit
          description: The type of action performed.
        messageId:
          type: string
          example: GFyazovL3VzL1BFT1BMRS80MDNlZmUwNy02Yzc3LTQyY2UtOWI4NC
          description: The parent message on which the attachment action was performed.
        inputs:
          type: object
          properties:
            Name:
              type: string
              example: John Andersen
            Url:
              type: string
              example: https://example.com
            Email:
              type: string
              example: john.andersen@example.com
            Tel:
              type: string
              example: +1 408 555 7209
          description: The action's inputs.
        created:
          type: string
          example: '2016-05-10T19:41:00.100Z'
          description: The date and time the action was created.
  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