openapi: 3.1.0
info:
  title: Agile CRM REST Campaigns Documents API
  version: 1.0.0
  description: HTTPS-only REST API for managing contacts, companies, deals (opportunities), campaigns, tasks, events, notes, tracks, tickets, and documents in Agile CRM. Authentication is HTTP Basic with account email as username and REST client API key as password.
  contact:
    name: Agile CRM
    url: https://www.agilecrm.com/api
servers:
- url: https://{domain}.agilecrm.com/dev
  description: Tenant-scoped base URL
  variables:
    domain:
      default: mydomain
      description: Your Agile CRM tenant subdomain
security:
- BasicAuth: []
tags:
- name: Documents
paths:
  /api/contacts/{contact_id}/documents:
    get:
      tags:
      - Documents
      summary: Get contact documents
      parameters:
      - $ref: '#/components/parameters/ContactId'
      responses:
        '200':
          description: Documents
    post:
      tags:
      - Documents
      summary: Create a document for a contact
      parameters:
      - $ref: '#/components/parameters/ContactId'
      responses:
        '200':
          description: Document created
  /api/contacts/{contact_id}/documents/{doc_id}:
    put:
      tags:
      - Documents
      summary: Update a contact document
      parameters:
      - $ref: '#/components/parameters/ContactId'
      - name: doc_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Document updated
components:
  parameters:
    ContactId:
      name: contact_id
      in: path
      required: true
      schema:
        type: string
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: HTTP Basic auth - username is account email, password is REST client API key.