openapi: 3.1.0
info:
  title: Aha! Account backups Creative briefs API
  version: 1.0.0
  description: Complete API documentation for Aha! generated from actual test responses
  contact:
    name: Aha! Support
    url: https://www.aha.io/support
servers:
- url: https://{account-domain}.aha.io/api/v1
  description: Aha! API Server
  variables:
    account-domain:
      description: Your Aha! account domain
      default: company
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
tags:
- name: Creative briefs
paths:
  /api/v1/products/{product_id}/creative_briefs:
    post:
      summary: Create a creative brief
      description: null
      tags:
      - Creative briefs
      parameters:
      - name: product_id
        in: path
        required: true
        schema:
          type: string
        description: ProductId identifier
      responses:
        '200':
          description: Successful operation
          headers:
            Content-Type:
              description: application/json; charset=utf-8
              schema:
                type: string
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/CreativebriefsPostResponse'
              example:
                creative_brief:
                  id: '6776881149490547091'
                  name: April launch
                  color: 13421772
                  created_at: '2019-01-01T00:00:00.000Z'
                  updated_at: '2019-01-01T00:00:00.000Z'
                  url: http://company.aha.io/creative_briefs/6776881149490547091
                  resource: http://company.aha.io/creative_briefs/6776881149490547091
                  custom_fields: []
                  comments_count: 0
      security:
      - OAuth2: []
      - ApiKeyAuth: []
      - CookieAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreativebriefsPostRequest'
            example:
              creative_brief:
                name: April launch
    get:
      summary: List creative briefs in a product
      description: null
      tags:
      - Creative briefs
      parameters:
      - name: product_id
        in: path
        required: true
        schema:
          type: string
        description: ProductId identifier
      responses:
        '200':
          description: Successful operation
          headers:
            Content-Type:
              description: application/json; charset=utf-8
              schema:
                type: string
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/CreativebriefsGetResponse'
              example:
                creative_briefs:
                - id: '91171755'
                  name: May launch
                  created_at: '2019-01-01T00:00:00.000Z'
                - id: '476477971'
                  name: April launch
                  created_at: '2019-01-01T00:00:00.000Z'
                - id: '982259096'
                  name: June launch
                  created_at: '2019-01-01T00:00:00.000Z'
                pagination:
                  total_records: 3
                  total_pages: 1
                  current_page: 1
      security:
      - OAuth2: []
      - ApiKeyAuth: []
      - CookieAuth: []
  /api/v1/creative_briefs/{id}:
    get:
      summary: Get a specific creative_brief
      description: null
      tags:
      - Creative briefs
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Id identifier
      responses:
        '200':
          description: Successful operation
          headers:
            Content-Type:
              description: application/json; charset=utf-8
              schema:
                type: string
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/CreativebriefsGetResponse'
              example:
                creative_brief:
                  id: '476477971'
                  name: April launch
                  color: 13421772
                  created_at: '2019-01-01T00:00:00.000Z'
                  updated_at: '2019-01-01T00:00:00.000Z'
                  url: http://company.aha.io/creative_briefs/476477971
                  resource: http://company.aha.io/creative_briefs/476477971
                  custom_fields: []
                  comments_count: 0
      security:
      - OAuth2: []
      - ApiKeyAuth: []
      - CookieAuth: []
  /api/v1/products/{product_id}/creative_briefs/{id}:
    put:
      summary: Update a creative brief
      description: null
      tags:
      - Creative briefs
      parameters:
      - name: product_id
        in: path
        required: true
        schema:
          type: string
        description: ProductId identifier
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Id identifier
      responses:
        '200':
          description: Successful operation
          headers:
            Content-Type:
              description: application/json; charset=utf-8
              schema:
                type: string
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/CreativebriefsPutResponse'
              example:
                creative_brief:
                  id: '476477971'
                  name: December launch
                  color: 13421772
                  created_at: '2019-01-01T00:00:00.000Z'
                  updated_at: '2019-01-01T00:00:00.000Z'
                  url: http://company.aha.io/creative_briefs/476477971
                  resource: http://company.aha.io/creative_briefs/476477971
                  custom_fields: []
                  comments_count: 0
      security:
      - OAuth2: []
      - ApiKeyAuth: []
      - CookieAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreativebriefsPostRequest'
            example:
              creative_brief:
                name: December launch
    delete:
      summary: Delete a creative brief
      description: null
      tags:
      - Creative briefs
      parameters:
      - name: product_id
        in: path
        required: true
        schema:
          type: string
        description: ProductId identifier
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Id identifier
      responses:
        '204':
          description: No content - operation successful
      security:
      - OAuth2: []
      - ApiKeyAuth: []
      - CookieAuth: []
components:
  schemas:
    CreativebriefsGetResponse:
      type: object
      properties:
        creative_brief:
          type: object
          properties:
            id:
              type: string
              example: '476477971'
            name:
              type: string
              example: April launch
            color:
              type: integer
              example: 13421772
            created_at:
              type: string
              example: '2019-01-01T00:00:00.000Z'
            updated_at:
              type: string
              example: '2019-01-01T00:00:00.000Z'
            url:
              type: string
              example: http://company.aha.io/creative_briefs/476477971
            resource:
              type: string
              example: http://company.aha.io/creative_briefs/476477971
            custom_fields:
              type: array
              items: {}
            comments_count:
              type: integer
              example: 0
          example:
            id: '476477971'
            name: April launch
            color: 13421772
            created_at: '2019-01-01T00:00:00.000Z'
            updated_at: '2019-01-01T00:00:00.000Z'
            url: http://company.aha.io/creative_briefs/476477971
            resource: http://company.aha.io/creative_briefs/476477971
            custom_fields: []
            comments_count: 0
      example:
        creative_brief:
          id: '476477971'
          name: April launch
          color: 13421772
          created_at: '2019-01-01T00:00:00.000Z'
          updated_at: '2019-01-01T00:00:00.000Z'
          url: http://company.aha.io/creative_briefs/476477971
          resource: http://company.aha.io/creative_briefs/476477971
          custom_fields: []
          comments_count: 0
    CreativebriefsPostRequest:
      type: object
      properties:
        creative_brief:
          type: object
          properties:
            name:
              type: string
              example: December launch
          example:
            name: December launch
      example:
        creative_brief:
          name: December launch
    CreativebriefsPutResponse:
      type: object
      properties:
        creative_brief:
          type: object
          properties:
            id:
              type: string
              example: '476477971'
            name:
              type: string
              example: December launch
            color:
              type: integer
              example: 13421772
            created_at:
              type: string
              example: '2019-01-01T00:00:00.000Z'
            updated_at:
              type: string
              example: '2019-01-01T00:00:00.000Z'
            url:
              type: string
              example: http://company.aha.io/creative_briefs/476477971
            resource:
              type: string
              example: http://company.aha.io/creative_briefs/476477971
            custom_fields:
              type: array
              items: {}
            comments_count:
              type: integer
              example: 0
          example:
            id: '476477971'
            name: December launch
            color: 13421772
            created_at: '2019-01-01T00:00:00.000Z'
            updated_at: '2019-01-01T00:00:00.000Z'
            url: http://company.aha.io/creative_briefs/476477971
            resource: http://company.aha.io/creative_briefs/476477971
            custom_fields: []
            comments_count: 0
      example:
        creative_brief:
          id: '476477971'
          name: December launch
          color: 13421772
          created_at: '2019-01-01T00:00:00.000Z'
          updated_at: '2019-01-01T00:00:00.000Z'
          url: http://company.aha.io/creative_briefs/476477971
          resource: http://company.aha.io/creative_briefs/476477971
          custom_fields: []
          comments_count: 0
    CreativebriefsPostResponse:
      type: object
      properties:
        creative_brief:
          type: object
          properties:
            id:
              type: string
              example: '6776881149490547091'
            name:
              type: string
              example: April launch
            color:
              type: integer
              example: 13421772
            created_at:
              type: string
              example: '2019-01-01T00:00:00.000Z'
            updated_at:
              type: string
              example: '2019-01-01T00:00:00.000Z'
            url:
              type: string
              example: http://company.aha.io/creative_briefs/6776881149490547091
            resource:
              type: string
              example: http://company.aha.io/creative_briefs/6776881149490547091
            custom_fields:
              type: array
              items: {}
            comments_count:
              type: integer
              example: 0
          example:
            id: '6776881149490547091'
            name: April launch
            color: 13421772
            created_at: '2019-01-01T00:00:00.000Z'
            updated_at: '2019-01-01T00:00:00.000Z'
            url: http://company.aha.io/creative_briefs/6776881149490547091
            resource: http://company.aha.io/creative_briefs/6776881149490547091
            custom_fields: []
            comments_count: 0
      example:
        creative_brief:
          id: '6776881149490547091'
          name: April launch
          color: 13421772
          created_at: '2019-01-01T00:00:00.000Z'
          updated_at: '2019-01-01T00:00:00.000Z'
          url: http://company.aha.io/creative_briefs/6776881149490547091
          resource: http://company.aha.io/creative_briefs/6776881149490547091
          custom_fields: []
          comments_count: 0
  securitySchemes:
    OAuth2:
      type: oauth2
      description: OAuth2 authentication with bearer tokens
      flows:
        authorizationCode:
          authorizationUrl: https://{account-domain}.aha.io/oauth/authorize
          tokenUrl: https://{account-domain}.aha.io/oauth/token
          scopes: {}
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: API key authentication using Bearer token in Authorization header. Generate API keys at https://secure.aha.io/settings/api_keys
    CookieAuth:
      type: apiKey
      in: cookie
      name: session
      description: Cookie-based authentication for web browser integration