components:
  responses: {}
  schemas:
    Error:
      properties:
        code:
          description: Podium code for the error.
          type: integer
        message:
          description: Specific details about the error.
          nullable: true
          type: string
        moreInfo:
          description: URL providing more information about the error.
          type: string
      title: Error
      type: object
    appointment:
      properties:
        assignedUser:
          description: Assigned user object
          nullable: true
          properties:
            uid:
              description: Podium unique identifier for user.
              example: 00000000-0000-0000-0000-000000000000
              format: uuid
              type: string
          type: object
        contactName:
          description: Name of the contact.
          nullable: true
          type: string
        contactPhoneNumber:
          description: Phone number of the contact.
          nullable: true
          type: string
        createdAt:
          description: When the appointment was created.
          example: '2015-01-23T23:50:07Z'
          format: date-time
          nullable: true
          type: string
        datetime:
          description: Date and time of the appointment.
          example: '2015-01-23T23:50:07Z'
          format: date-time
          nullable: true
          type: string
        durationMin:
          description: How many miuntes long the appointment is.
          nullable: true
          type: integer
        location:
          description: Location object
          nullable: true
          properties:
            uid:
              description: Podium unique identifier for location.
              example: 00000000-0000-0000-0000-000000000000
              format: uuid
              type: string
          type: object
        note:
          description: Note that is attached to the appointment.
          nullable: true
          type: string
        status:
          description: Status of the appointment.
          enum:
          - cancelled
          - completed
          - confirmed
          - no_show
          - unconfirmed
          nullable: true
          type: string
        type:
          description: Type of appointment.
          enum:
          - in_person
          - virtual
          nullable: true
          type: string
        uid:
          description: Podium unique identifier for appointment.
          example: 00000000-0000-0000-0000-000000000000
          format: uuid
          type: string
        updatedAt:
          description: When the appointment was updated.
          example: '2015-01-23T23:50:07Z'
          format: date-time
          nullable: true
          type: string
      title: appointment
      type: object
info:
  title: Appointments
  version: 2021.04.01
openapi: 3.0.0
paths:
  /v4/appointments:
    post:
      callbacks: {}
      description: 'Create an appointment.


        Required scope: `write_appointments`.'
      operationId: appointment.create
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              properties:
                assignedUserUid:
                  description: Podium unique identifier for user.
                  example: 00000000-0000-0000-0000-000000000000
                  format: uuid
                  type: string
                contactName:
                  description: Name of the contact.
                  example: John Doe
                  type: string
                contactPhoneNumber:
                  description: Phone number of the contact. Phone number should be formatted as '+15555555555'
                  example: '+17626765098'
                  type: string
                datetime:
                  description: Date and time of the appointment.
                  example: '2015-01-23T23:50:07Z'
                  format: date-time
                  type: string
                durationMin:
                  description: How many minutes long the appointment is.
                  type: integer
                locationUid:
                  description: Podium unique identifier for location.
                  example: 00000000-0000-0000-0000-000000000000
                  format: uuid
                  type: string
                note:
                  description: Note that is attached to the appointment.
                  example: Note for the appointment.
                  maxLength: 500
                  type: string
                status:
                  default: unconfirmed
                  description: Status of the appointment.
                  enum:
                  - cancelled
                  - completed
                  - confirmed
                  - no_show
                  - unconfirmed
                  type: string
                type:
                  default: in_person
                  description: Type of appointment.
                  enum:
                  - in_person
                  - virtual
                  type: string
              required:
              - contactName
              - contactPhoneNumber
              - datetime
              - locationUid
              type: object
        description: Create appointment params
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/appointment'
                  metadata:
                    description: Additional response data.
                    properties:
                      url:
                        description: The resource URL.
                        example: https://www.podium.com/
                        type: string
                    type: object
                type: object
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                properties:
                  code:
                    description: Podium code for the error.
                    type: integer
                  message:
                    description: Specific details about the error.
                    nullable: true
                    type: string
                  moreInfo:
                    description: URL providing more information about the error.
                    type: string
                title: Error
                type: object
          description: Error response.
      summary: Create an appointment.
      tags:
      - Appointment
security: []
servers:
- url: https://api.podium.com
  variables: {}
tags: []