{
  "opencollection": "1.0.0",
  "info": {
    "name": "Didomi consents/events notices API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "notices",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve a list of notice texts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.didomi.io/v1/widgets/notices/texts",
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns a list of notice texts"
        },
        {
          "info": {
            "name": "Create a notice text",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.didomi.io/v1/widgets/notices/texts",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Create a new notice text for an organization"
        },
        {
          "info": {
            "name": "Retrieve a notice text",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.didomi.io/v1/widgets/notices/texts/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the notice text to retrieve"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns a single notice text"
        },
        {
          "info": {
            "name": "Update a notice text",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.didomi.io/v1/widgets/notices/texts/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the notice text to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Update an existing notice text"
        },
        {
          "info": {
            "name": "Patch a notice text",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.didomi.io/v1/widgets/notices/texts/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the notice text to patch"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Partially update a notice text"
        },
        {
          "info": {
            "name": "Retrieve a list of notice text contents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.didomi.io/v1/widgets/notices/texts-contents",
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns a list of notice text contents"
        },
        {
          "info": {
            "name": "Create a notice text content",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.didomi.io/v1/widgets/notices/texts-contents",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Retrieve a notice text content",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.didomi.io/v1/widgets/notices/texts-contents/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the notice text content to retrieve"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns a single notice text content"
        },
        {
          "info": {
            "name": "Update a notice text content",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.didomi.io/v1/widgets/notices/texts-contents/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the notice text content to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Patch a notice text content",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.didomi.io/v1/widgets/notices/texts-contents/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the notice text content to patch"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Delete a notice text content",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.didomi.io/v1/widgets/notices/texts-contents/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the notice text content to delete"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Generate a SDK configuration",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.didomi.io/v1/widgets/notices/generators/sdk",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Generate a SDK configuration from a notice configuration"
        },
        {
          "info": {
            "name": "Generate a Notice configuration",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.didomi.io/v1/widgets/notices/generators/configs",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Generate a Notice configuration from a SDK configuration"
        },
        {
          "info": {
            "name": "Retrieve a list of notice template configurations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.didomi.io/v1/widgets/notices/templates/configs",
            "params": [
              {
                "name": "$limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "$skip",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns a list of notice template configurations"
        },
        {
          "info": {
            "name": "Retrieve a notice template configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.didomi.io/v1/widgets/notices/templates/configs/:id",
            "params": [
              {
                "name": "template_id",
                "value": "",
                "type": "path",
                "description": "The ID of the notice template to retrieve configuration"
              },
              {
                "name": "$limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "$skip",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns a single notice template configuration"
        },
        {
          "info": {
            "name": "Update a notice template configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.didomi.io/v1/widgets/notices/templates/configs/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the notice template configuration to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Update an existing notice template configuration."
        },
        {
          "info": {
            "name": "Patch a notice template configuration",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.didomi.io/v1/widgets/notices/templates/configs/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the notice template configuration to patch"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Partially update an existing notice template configuration."
        },
        {
          "info": {
            "name": "DELETE /widgets/notices/templates/configs/{id}",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.didomi.io/v1/widgets/notices/templates/configs/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of notices to remove"
              }
            ]
          },
          "docs": "Removes the resource with id."
        },
        {
          "info": {
            "name": "Retrieve a list of notices templates",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.didomi.io/v1/widgets/notices/templates",
            "params": [
              {
                "name": "$limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "$skip",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns a list of notices templates"
        },
        {
          "info": {
            "name": "Create a notice template",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.didomi.io/v1/widgets/notices/templates",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Create a new notice template for an organization."
        },
        {
          "info": {
            "name": "Retrieve a notice template",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.didomi.io/v1/widgets/notices/templates/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the notice template to retrieve"
              },
              {
                "name": "$limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "$skip",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns a single notice template"
        },
        {
          "info": {
            "name": "PUT /widgets/notices/templates/{id}",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.didomi.io/v1/widgets/notices/templates/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of notices to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the resource identified by id using data."
        },
        {
          "info": {
            "name": "Patch a notice template, and associate notice template with notices",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.didomi.io/v1/widgets/notices/templates/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the notice template to patch"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Partially update an existing notice template."
        },
        {
          "info": {
            "name": "Removes the notice template, and associated notice template config",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.didomi.io/v1/widgets/notices/templates/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the notice template to patch"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Removes the notice template."
        },
        {
          "info": {
            "name": "Retrieve a list of deployments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.didomi.io/v1/widgets/notices/deployments",
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns a list of deployments"
        },
        {
          "info": {
            "name": "Create a deployment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.didomi.io/v1/widgets/notices/deployments",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Create a new deployment for an organization"
        },
        {
          "info": {
            "name": "Retrieve a deployment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.didomi.io/v1/widgets/notices/deployments/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deployment to retrieve"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns a single deployment"
        },
        {
          "info": {
            "name": "Retrieve a list of configurations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.didomi.io/v1/widgets/notices/configs",
            "headers": [
              {
                "name": "v",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "download",
                "value": "",
                "type": "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."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns a list of configurations"
        },
        {
          "info": {
            "name": "Retrieve a notice configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.didomi.io/v1/widgets/notices/configs/:id",
            "headers": [
              {
                "name": "v",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the notice configuration to retrieve"
              },
              {
                "name": "download",
                "value": "",
                "type": "query",
                "description": "Flag to indicate the response should be returned as an attachment (interpreted as true if present regardless of value)"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns a single notice configuration"
        },
        {
          "info": {
            "name": "Patch a notice configuration",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.didomi.io/v1/widgets/notices/configs/:id",
            "headers": [
              {
                "name": "v",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the notice configuration to patch"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Partially update a notice configuration"
        },
        {
          "info": {
            "name": "Retrieve a list of SDK configurations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.didomi.io/v1/widgets/notices/sdk-configs",
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns a list of SDK configurations"
        },
        {
          "info": {
            "name": "Retrieve a SDK configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.didomi.io/v1/widgets/notices/sdk-configs/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the SDK configuration to retrieve"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns a single SDK configuration"
        },
        {
          "info": {
            "name": "Retrieve a list of notices",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.didomi.io/v1/widgets/notices",
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns a list of notices"
        },
        {
          "info": {
            "name": "Create a notice",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.didomi.io/v1/widgets/notices",
            "params": [
              {
                "name": "duplicate",
                "value": "",
                "type": "query",
                "description": "The ID of the notice you want to duplicate"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Create a new notice for an organization"
        },
        {
          "info": {
            "name": "Retrieve a notice",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.didomi.io/v1/widgets/notices/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the notice to retrieve"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns a single notice"
        },
        {
          "info": {
            "name": "Update a notice",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.didomi.io/v1/widgets/notices/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the notice to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Update an existing notice"
        },
        {
          "info": {
            "name": "Patch a notice",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.didomi.io/v1/widgets/notices/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the notice to patch"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Partially update a notice"
        },
        {
          "info": {
            "name": "Delete a notice",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.didomi.io/v1/widgets/notices/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the notice to delete"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Delete an existing notice"
        }
      ]
    }
  ],
  "bundled": true
}