openapi: 3.2.0
info:
  title: Beacon Rest Services Update Status Change API
  description: 'A combination of all methods in the beacon-api


    [ BASE URL: https://beaconproplus.com


    Beacon ProPlus


    Version 1: https://beaconproplus.com/v1/rest/com/becn


    Version 2: https://beaconproplus.com/v2/rest/com/becn


    Version 3: https://beaconproplus.com/v3/rest/com/becn


    Beacon Stack


    [ BASE URL: https://beacon-api-x7xzzdp35a-uk.a.run.app


    Version 1: https://beacon-api-x7xzzdp35a-uk.a.run.app/v1/rest/com/becn/


    Version 2: https://beacon-api-x7xzzdp35a-uk.a.run.app/v2/rest/com/becn/


    Version 3…'
  version: '1.0'
  contact: {}
servers: []
tags:
- name: UpdateStatusChange
paths:
  /updateStatusChange:
    post:
      operationId: V2Controller_updateStatusChange
      summary: Updates delivery tracking status for current user
      description: Updates delivery tracking method used to deliver notifications to a user. These delivery methods can be "none", "email", "sms", or "email and sms".
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateStatusChangeBody'
      responses:
        '200':
          description: successful operation<br><br>refer to the <i>API Uniform Format</i> dropdown above
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/updateStatusChangeResponse'
        '400':
          description: Bad Request, accountId is invalid.
        '401':
          description: Unauthorized, the authorization bearer token is invalid.
        '405':
          description: Method not allowed, the request method is not valid for this API or this API is not available.
        '500':
          description: Internal exception.
      tags:
      - UpdateStatusChange
components:
  schemas:
    updateStatusChangeResponse:
      type: object
      properties:
        messageCode:
          type: string
        message:
          type: string
      required:
      - messageCode
      - message
    updateStatusChangeBody:
      type: object
      properties:
        dtEmailAddress:
          type: string
        dtPhoneNumber:
          type: string
        dtStatusChangeNotification:
          $ref: '#/components/schemas/DtStatusChangeNotification'
        dtAdminStatusChangeNotification:
          $ref: '#/components/schemas/DtStatusChangeNotification'
        dtAccountStatusChangeNotification:
          type: array
          items:
            $ref: '#/components/schemas/DtAccountStatusChangeNotification'
      required:
      - dtEmailAddress
      - dtPhoneNumber
      - dtStatusChangeNotification
      - dtAdminStatusChangeNotification
      - dtAccountStatusChangeNotification
    DtAccountStatusChangeNotification:
      type: object
      properties:
        requested:
          type: string
        scheduled:
          type: string
        delivered:
          type: string
        accountId:
          type: string
      required:
      - requested
      - scheduled
      - delivered
      - accountId
    DtStatusChangeNotification:
      type: object
      properties:
        requested:
          type: string
        scheduled:
          type: string
        delivered:
          type: string
      required:
      - requested
      - scheduled
      - delivered