openapi: 3.2.0
info:
  title: PLATFORM Contacts API
  version: 1.0.0
servers:
- url: https://api.synthflow.ai/v2
  description: Global
- url: https://api.us.synthflow.ai/v2
  description: United States
- url: https://api.eu.synthflow.ai/v2
  description: European Union
tags:
- name: contacts
paths:
  /contacts:
    post:
      operationId: create-a-contact
      summary: Create a contact
      description: ''
      tags:
      - contacts
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contacts_create-a-contact_Response_200'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The contact's name.
                phone_number:
                  type: string
                  description: The contact's phone number.
                email:
                  type: string
                  description: The contact's email address.
                contact_metadata:
                  $ref: '#/components/schemas/ContactsPostRequestBodyContentApplicationJsonSchemaContactMetadata'
                  description: Additional metadata for the contact.
              required:
              - name
              - phone_number
  /contacts/{contact_id}:
    patch:
      operationId: update-a-contact
      summary: Update a contact
      description: ''
      tags:
      - contacts
      parameters:
      - name: contact_id
        in: path
        description: The contact's ID.
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contacts_update-a-contact_Response_200'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The contact's name.
                phone_number:
                  type: string
                  description: The contact's phone number.
                email:
                  type: string
                  description: The contact's email.
                contact_metadata:
                  $ref: '#/components/schemas/ContactsContactIdPatchRequestBodyContentApplicationJsonSchemaContactMetadata'
components:
  schemas:
    Contacts_create-a-contact_Response_200:
      type: object
      properties:
        status:
          type: string
        response:
          $ref: '#/components/schemas/ContactsPostResponsesContentApplicationJsonSchemaResponse'
      title: Contacts_create-a-contact_Response_200
    Contacts_update-a-contact_Response_200:
      type: object
      properties:
        status:
          type: string
      title: Contacts_update-a-contact_Response_200
    ContactsPostRequestBodyContentApplicationJsonSchemaContactMetadata:
      type: object
      properties:
        company:
          type: string
      description: Additional metadata for the contact.
      title: ContactsPostRequestBodyContentApplicationJsonSchemaContactMetadata
    ContactsPostResponsesContentApplicationJsonSchemaResponse:
      type: object
      properties:
        id:
          type: string
      title: ContactsPostResponsesContentApplicationJsonSchemaResponse
    ContactsContactIdPatchRequestBodyContentApplicationJsonSchemaContactMetadata:
      type: object
      properties: {}
      title: ContactsContactIdPatchRequestBodyContentApplicationJsonSchemaContactMetadata
  securitySchemes:
    sec0:
      type: http
      scheme: bearer