Didomi notices API

openapi: 3.0.2
info:
  title: Didomi consents/events notices API
  description: 'A REST API to communicate with the Didomi platform (<a href="https://api.didomi.io/v1/">https://api.didomi.io/v1/</a>)


    This is the complete specification of the API. A complete guide to authenticating and using the API is available on our <a href="https://developers.didomi.io/" target="_blank">Developers Portal</a>.


    All HTTP calls to the API require a valid JWT token. The token must be provided in an **Authorization** header with the value "Bearer <token>".

    Click on the Authorize button in the header of this page to provide a token before testing requests from this documentation.


    '
  version: '1.0'
servers:
- url: https://api.didomi.io/v1
  description: Didomi Platform API
security:
- bearer: []
tags:
- name: notices
paths:
  /widgets/notices/texts:
    get:
      parameters: []
      responses:
        '200':
          description: A list of NoticeText objects
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/notices-text'
      description: Returns a list of notice texts
      summary: Retrieve a list of notice texts
      tags:
      - notices
      security:
      - bearer: []
    post:
      parameters:
      - name: notices-text
        in: body
        description: The notice text object to create
        required: true
        schema:
          $ref: '#/components/schemas/notices-text-input'
      responses:
        '200':
          description: The created NoticeText object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notices-text'
      description: Create a new notice text for an organization
      summary: Create a notice text
      tags:
      - notices
      security:
      - bearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/notices'
  /widgets/notices/texts/{id}:
    get:
      parameters:
      - name: id
        in: path
        description: The ID of the notice text to retrieve
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A NoticeText object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notices-text'
      description: Returns a single notice text
      summary: Retrieve a notice text
      tags:
      - notices
      security:
      - bearer: []
    put:
      parameters:
      - name: id
        in: path
        description: The ID of the notice text to update
        required: true
        schema:
          type: string
      - name: notices-text
        in: body
        description: The new notice text to update
        required: true
        schema:
          $ref: '#/components/schemas/notices-text-input'
      responses:
        '200':
          description: The updated NoticeText object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notices-text'
      description: Update an existing notice text
      summary: Update a notice text
      tags:
      - notices
      security:
      - bearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/notices'
    patch:
      parameters:
      - name: id
        in: path
        description: The ID of the notice text to patch
        required: true
        schema:
          type: string
      - name: notices-text
        in: body
        description: The properties to replace on the notice text object
        required: true
        schema:
          $ref: '#/components/schemas/notices-text-input'
      responses:
        '200':
          description: The patched NoticeText object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notices-text'
      description: Partially update a notice text
      summary: Patch a notice text
      tags:
      - notices
      security:
      - bearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/notices'
  /widgets/notices/texts-contents:
    get:
      parameters: []
      responses:
        '200':
          description: A list of NoticeTextContent objects
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/notices-text-content'
      description: Returns a list of notice text contents
      summary: Retrieve a list of notice text contents
      tags:
      - notices
      security:
      - bearer: []
    post:
      parameters:
      - name: notices-text-content
        in: body
        description: The notice text content object to create
        required: true
        schema:
          $ref: '#/components/schemas/notices-text-content-input'
      responses:
        '200':
          description: The created NoticeTextContent object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notices-text-content'
      description: Create a new notice text content for an organization. A content version will be automatically assigned and the content will need to go through the approval process from the Didomi team before it can be used in a notice. If there is already an approved content for a given notice text, it remains available for notices until the new version of the content get approved.
      summary: Create a notice text content
      tags:
      - notices
      security:
      - bearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/notices'
  /widgets/notices/texts-contents/{id}:
    get:
      parameters:
      - name: id
        in: path
        description: The ID of the notice text content to retrieve
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A NoticeTextContent object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notices-text-content'
      description: Returns a single notice text content
      summary: Retrieve a notice text content
      tags:
      - notices
      security:
      - bearer: []
    put:
      parameters:
      - name: id
        in: path
        description: The ID of the notice text content to update
        required: true
        schema:
          type: string
      - name: notices-text-content
        in: body
        description: The new notice text content to update
        required: true
        schema:
          $ref: '#/components/schemas/notices-text-content-input'
      responses:
        '200':
          description: The updated NoticeTextContent object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notices-text-content'
      description: Update an existing notice text content. Text contents cannot be modified once their status is "approved". If you want to update an approved text content, create a new content for the same text and get it approved again by the Didomi team.
      summary: Update a notice text content
      tags:
      - notices
      security:
      - bearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/notices'
    patch:
      parameters:
      - name: id
        in: path
        description: The ID of the notice text content to patch
        required: true
        schema:
          type: string
      - name: notices-text-content
        in: body
        description: The properties to replace on the notice text content object
        required: true
        schema:
          $ref: '#/components/schemas/notices-text-content-input'
      responses:
        '200':
          description: The patched NoticeTextContent object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notices-text-content'
      description: Partially update an existing notice text content. Text contents cannot be modified once their status is "approved". If you want to update an approved text content, create a new content for the same text and get it approved again by the Didomi team.
      summary: Patch a notice text content
      tags:
      - notices
      security:
      - bearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/notices'
    delete:
      parameters:
      - name: id
        in: path
        description: The ID of the notice text content to delete
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The deleted NoticeTextContent object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notices-text-content'
      description: Delete an existing notice text content. Text contents cannot be deleted once their status is "approved". If you want to update an approved text content, create a new content for the same text and get it approved again by the Didomi team.
      summary: Delete a notice text content
      tags:
      - notices
      security:
      - bearer: []
  /widgets/notices/generators/sdk:
    post:
      parameters:
      - name: config
        in: body
        description: The notice configuration object to transform
        required: true
        schema:
          $ref: '#/components/schemas/sdk-configs-input'
      responses:
        '200':
          description: The generated SDK configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sdk-configs'
      description: Generate a SDK configuration from a notice configuration
      summary: Generate a SDK configuration
      tags:
      - notices
      security:
      - bearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/notices'
  /widgets/notices/generators/configs:
    post:
      parameters:
      - name: config
        in: body
        description: The SDK configuration object to transform
        required: true
        schema:
          $ref: '#/components/schemas/notice-configs-input'
      responses:
        '200':
          description: The generated notice configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notice-configs'
      description: Generate a Notice configuration from a SDK configuration
      summary: Generate a Notice configuration
      tags:
      - notices
      security:
      - bearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/notices'
  /widgets/notices/templates/configs:
    get:
      parameters:
      - name: $limit
        in: query
        required: false
        schema:
          type: number
        default: 0
        minimum: 0
      - name: $skip
        in: query
        required: false
        schema:
          type: number
        default: 10
        minimum: 0
      responses:
        '200':
          description: A NoticeTemplateConfig object
          content:
            application/json:
              schema:
                type: object
                description: A paginated list of notice template configuration objects
                properties:
                  total:
                    type: number
                    description: The total number of template configurations
                  limit:
                    type: number
                    description: The maximum number of template configurations returned
                  skip:
                    type: number
                    description: Number of template configurations skipped
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/notices-templates-configs'
      description: Returns a list of notice template configurations
      summary: Retrieve a list of notice template configurations
      tags:
      - notices
      security:
      - bearer: []
  /widgets/notices/templates/configs/{id}:
    get:
      parameters:
      - name: template_id
        in: path
        description: The ID of the notice template to retrieve configuration
        required: false
        schema:
          type: string
      - name: $limit
        in: query
        required: false
        schema:
          type: number
        default: 0
        minimum: 0
      - name: $skip
        in: query
        required: false
        schema:
          type: number
        default: 10
        minimum: 0
      responses:
        '200':
          description: A NoticeTemplateConfig object
          content:
            application/json:
              schema:
                type: object
                description: A paginated list of notice template configuration objects
                properties:
                  total:
                    type: number
                    description: The total number of template configurations
                  limit:
                    type: number
                    description: The maximum number of template configurations returned
                  skip:
                    type: number
                    description: Number of template configurations skipped
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/notices-templates-configs'
      description: Returns a single notice template configuration
      summary: Retrieve a notice template configuration
      tags:
      - notices
      security:
      - bearer: []
    put:
      parameters:
      - name: id
        in: path
        description: The ID of the notice template configuration to update
        required: true
        schema:
          type: string
      - name: notice-template-config
        in: body
        description: The new notice template configuration to update
        required: true
        schema:
          $ref: '#/components/schemas/notices-templates-configs-input'
      responses:
        '200':
          description: The updated NoticeTemplateConfig object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notices-templates-configs'
      description: Update an existing notice template configuration.
      summary: Update a notice template configuration
      tags:
      - notices
      security:
      - bearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/notices'
    patch:
      parameters:
      - name: id
        in: path
        description: The ID of the notice template configuration to patch
        required: true
        schema:
          type: string
      - name: notice-template
        in: body
        description: The properties to replace on the notice template configuration object
        required: true
        schema:
          $ref: '#/components/schemas/notices-templates-configs'
      responses:
        '200':
          description: The patched NoticeTemplateConfig object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notices-templates-configs'
      description: Partially update an existing notice template configuration.
      summary: Patch a notice template configuration
      tags:
      - notices
      security:
      - bearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/notices'
    delete:
      parameters:
      - in: path
        name: id
        description: ID of notices to remove
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notices'
        '401':
          description: not authenticated
        '404':
          description: not found
        '500':
          description: general error
      description: Removes the resource with id.
      summary: ''
      tags:
      - notices
      security: []
  /widgets/notices/templates:
    get:
      parameters:
      - name: $limit
        in: query
        required: false
        schema:
          type: number
        default: 0
        minimum: 0
      - name: $skip
        in: query
        required: false
        schema:
          type: number
        default: 10
        minimum: 0
      responses:
        '200':
          description: A NoticeTemplate object
          content:
            application/json:
              schema:
                type: object
                description: A paginated list of notices templates objects
                properties:
                  total:
                    type: number
                    description: The total number of templates
                  limit:
                    type: number
                    description: The maximum number of templates returned
                  skip:
                    type: number
                    description: Number of templates skipped
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/notices-templates'
      description: Returns a list of notices templates
      summary: Retrieve a list of notices templates
      tags:
      - notices
      security:
      - bearer: []
    post:
      parameters:
      - name: notice-template
        in: body
        description: The notice template name to create
        required: true
        schema:
          $ref: '#/components/schemas/notices-templates-input'
      responses:
        '200':
          description: The created NoticeTemplate object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notices-templates'
      description: Create a new notice template for an organization.
      summary: Create a notice template
      tags:
      - notices
      security:
      - bearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/notices'
  /widgets/notices/templates/{id}:
    get:
      parameters:
      - name: id
        in: path
        description: The ID of the notice template to retrieve
        required: false
        schema:
          type: string
      - name: $limit
        in: query
        required: false
        schema:
          type: number
        default: 0
        minimum: 0
      - name: $skip
        in: query
        required: false
        schema:
          type: number
        default: 10
        minimum: 0
      responses:
        '200':
          description: A NoticeTemplate object
          content:
            application/json:
              schema:
                type: object
                description: A paginated list of notices templates objects
                properties:
                  total:
                    type: number
                    description: The total number of templates
                  limit:
                    type: number
                    description: The maximum number of templates returned
                  skip:
                    type: number
                    description: Number of templates skipped
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/notices-templates'
      description: Returns a single notice template
      summary: Retrieve a notice template
      tags:
      - notices
      security:
      - bearer: []
    put:
      parameters:
      - in: path
        name: id
        description: ID of notices to update
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notices'
        '401':
          description: not authenticated
        '404':
          description: not found
        '500':
          description: general error
      description: Updates the resource identified by id using data.
      summary: ''
      tags:
      - notices
      security: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/notices'
    patch:
      parameters:
      - name: id
        in: path
        description: The ID of the notice template to patch
        required: true
        schema:
          type: string
      - name: notice-template
        in: body
        description: The properties to replace on the notice template object
        required: true
        schema:
          $ref: '#/components/schemas/notices-templates-input'
      responses:
        '200':
          description: The patched NoticeTemplate object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notices-templates'
      description: Partially update an existing notice template.
      summary: Patch a notice template, and associate notice template with notices
      tags:
      - notices
      security:
      - bearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/notices'
    delete:
      parameters:
      - name: id
        in: path
        description: The ID of the notice template to patch
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The removed NoticeTemplate object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notices-templates'
      description: Removes the notice template.
      summary: Removes the notice template, and associated notice template config
      tags:
      - notices
      security:
      - bearer: []
  /widgets/notices/deployments:
    get:
      parameters: []
      responses:
        '200':
          description: A list of NoticeDeployment objects
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/notices-deployments'
      description: Returns a list of deployments
      summary: Retrieve a list of deployments
      tags:
      - notices
      security:
      - bearer: []
    post:
      parameters:
      - name: notice
        in: body
        description: The deployment object to create
        required: true
        schema:
          $ref: '#/components/schemas/notices-deployments-input'
      responses:
        '200':
          description: The created NoticeDeployment object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notices-deployments'
      description: Create a new deployment for an organization
      summary: Create a deployment
      tags:
      - notices
      security:
      - bearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/notices'
  /widgets/notices/deployments/{id}:
    get:
      parameters:
      - name: id
        in: path
        description: The ID of the deployment to retrieve
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A NoticeDeployment object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notices-deployments'
      description: Returns a single deployment
      summary: Retrieve a deployment
      tags:
      - notices
      security:
      - bearer: []
  /widgets/notices/configs:
    get:
      parameters:
      - name: download
        in: query
        description: Flag to indicate the response should be returned as an attachment (interpreted as true if present regardless of value). Responds with a CSV extract of the items or Not Found if no items match the query.
        required: false
        allowEmptyValue: true
        type: string
      - name: v
        in: header
        description: 'Header to indicate Notice-Config API version. 1: Legacy. 2: Multi-Regulation'
        required: false
        allowEmptyValue: false
        schema:
          type: string
          enum:
          - '1'
          - '2'
          default: '1'
      responses:
        '200':
          description: A list of NoticeConfig objects
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/notices-config'
      description: Returns a list of configurations
      summary: Retrieve a list of configurations
      tags:
      - notices
      security:
      - bearer: []
  /widgets/notices/configs/{id}:
    get:
      parameters:
      - name: id
        in: path
        description: The ID of the notice configuration to retrieve
        required: true
        schema:
          type: string
      - name: download
        in: query
        description: Flag to indicate the response should be returned as an attachment (interpreted as true if present regardless of value)
        required: false
        allowEmptyValue: true
        type: string
      - name: v
        in: header
        description: 'Header to indicate Notice-Config API version. 1: Legacy. 2: Multi-Regulation'
        required: false
        allowEmptyValue: false
        schema:
          type: string
          enum:
          - '1'
          - '2'
          default: '1'
      responses:
        '200':
          description: A NoticeConfig object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notices-config'
      description: Returns a single notice configuration
      summary: Retrieve a notice configuration
      tags:
      - notices
      security:
      - bearer: []
    patch:
      parameters:
      - name: id
        in: path
        description: The ID of the notice configuration to patch
        required: true
        schema:
          type: string
      - name: notices-config
        in: body
        description: The properties to replace on the notice configuration object
        required: true
        schema:
          $ref: '#/components/schemas/notices-config-input'
      - name: v
        in: header
        description: 'Header to indicate Notice-Config API version. 1: Legacy. 2: Multi-Regulation'
        required: false
        allowEmptyValue: false
        schema:
          type: string
          enum:
          - '1'
          - '2'
          default: '1'
      responses:
        '200':
          description: The patched NoticeConfig object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notices-config'
      description: Partially update a notice configuration
      summary: Patch a notice configuration
      tags:
      - notices
      security:
      - bearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/notices'
  /widgets/notices/sdk-configs:
    get:
      parameters: []
      responses:
        '200':
          description: A list of SDK Configs objects
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/notices-sdk-config'
      description: Returns a list of SDK configurations
      summary: Retrieve a list of SDK configurations
      tags:
      - notices
      security:
      - bearer: []
  /widgets/notices/sdk-configs/{id}:
    get:
      parameters:
      - name: id
        in: path
        description: The ID of the SDK configuration to retrieve
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A SDK config object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notices-sdk-config'
      description: Returns a single SDK configuration
      summary: Retrieve a SDK configuration
      tags:
      - notices
      security:
      - bearer: []
  /widgets/notices:
    get:
      parameters: []
      responses:
        '200':
          description: A list of Notice objects
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/notices'
      description: Returns a list of notices
      summary: Retrieve a list of notices
      tags:
      - notices
      security:
      - bearer: []
    post:
      parameters:
      - name: duplicate
        in: query
        description: The ID of the notice you want to duplicate
        required: false
        schema:
          type: string
      - name: notice
        in: body
        description: The Notice object to create
        required: true
        schema:
          $ref: '#/components/schemas/notices-input'
      responses:
        '200':
          description: The created Notice object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notices'
      description: Create a new notice for an organization
      summary: Create a notice
      tags:
      - notices
      security:
      - bearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/notices'
  /widgets/notices/{id}:
    get:
      parameters:
      - name: id
        in: path
        description: ID of the notice to retrieve
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A Notice object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notices'
      description: Returns a single notice
      summary: Retrieve a notice
      tags:
      - notices
      security:
      - bearer: []
    put:
      parameters:
      - name: id
        in: path
        description: The ID of the notice to update
        required: true
        schema:
          type: string
      - name: notices
        in: body
        description: The new notice to update
        required: true
        schema:
          $ref: '#/components/schemas/notices-input'
      responses:
        '200':
          description: The updated Notice object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notices'
      description: Update an existing notice
      summary: Update a notice
      tags:
      - notices
      security:
      - bearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/notices'
    patch:
      parameters:
      - name: id
        in: path
        description: The ID of the notice to patch
        required: true
        schema:
          type: string
      - name: notices
        in: body
        description: The properties to replace on the notice object
        required: true
        schema:
          $ref: '#/components/schemas/notices-input'
      responses:
 

# --- truncated at 32 KB (99 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/didomi/refs/heads/main/openapi/didomi-notices-api-openapi.yml