openapi: 3.2.0
info:
  title: transacionais Emails API
  version: '1.0'
servers:
- url: https://api.iugu.com/v1
security:
- sec0: []
tags:
- name: Emails
paths:
  /emails:
    post:
      summary: Criar E-mail
      description: ''
      operationId: criar-email
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - identifier
              - template
              - subject
              - active
              properties:
                identifier:
                  type: string
                  description: Identificador do email (Deve ser enviado um dos itens retornados pela API de 'Listar Emails Disponíveis')
                template:
                  type: string
                  description: Template do email
                subject:
                  type: string
                  description: Assunto do email
                active:
                  type: boolean
                  description: Determina se o email ficará ativo ou não logo após a criação
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n    \"id\": \"3EC8BC740F9A47349F23C282A1D22383\",\n    \"identifier\": \"invoice_refund\",\n    \"template\": \"Template do email\",\n    \"subject\": \"Assunto do email\",\n    \"active\": true\n}"
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: 3EC8BC740F9A47349F23C282A1D22383
                  identifier:
                    type: string
                    example: invoice_refund
                  template:
                    type: string
                    example: Template do email
                  subject:
                    type: string
                    example: Assunto do email
                  active:
                    type: boolean
                    example: true
                    default: true
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n    \"errors\": \"Account email Not Found\"\n}"
              schema:
                type: object
                properties:
                  errors:
                    type: string
                    example: Account email Not Found
        '422':
          description: '422'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n    \"errors\": {\n        \"identifier\": [\n            \"is invalid\"\n        ]\n    }\n}"
              schema:
                type: object
                properties:
                  errors:
                    type: object
                    properties:
                      identifier:
                        type: array
                        items:
                          type: string
                          example: is invalid
      deprecated: false
      tags:
      - Emails
    get:
      summary: Listar E-mails
      description: Retorna a lista de e-mails.
      operationId: listar-emails
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "[\n    {\n        \"id\": \"052F0AAE2A384F5C9DBE121F7E2CC5EC\",\n        \"identifier\": \"invoice_due\",\n        \"template\": \"Template do email\",\n        \"subject\": \"Assunto do email\",\n        \"active\": true\n    },\n    {\n        \"id\": \"10FFAE07CC004C5EBBBA2B9E1565704A\",\n        \"identifier\": \"subscription_trial_remainder\",\n        \"template\": \"Template do email\",\n        \"subject\": \"Assunto do email\",\n        \"active\": true\n    },\n    {\n        \"id\": \"3EC8BC740F9A47349F23C282A1D22383\",\n        \"identifier\": \"invoice_refund\",\n        \"template\": \"Template do email\",\n        \"subject\": \"Assunto do email\",\n        \"active\": true\n    },\n    {\n        \"id\": \"41B00BE9F8914680A3947DA6BC457168\",\n        \"identifier\": \"subscription_changed\",\n        \"template\": \"Template do email\",\n        \"subject\": \"Assunto do email\",\n        \"active\": true\n    },\n    {\n        \"id\": \"7545BC74A8B14CD880B1AD2B992BBF5C\",\n        \"identifier\": \"invoice_reminder\",\n        \"template\": \"Template do email\",\n        \"subject\": \"Assunto do email\",\n        \"active\": true\n    },\n    {\n        \"id\": \"B53F8C3F958D4B50AB119EEC5F665979\",\n        \"identifier\": \"invoice_canceled\",\n        \"template\": \"Template do email\",\n        \"subject\": \"Assunto do email\",\n        \"active\": true\n    }\n]"
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      example: 052F0AAE2A384F5C9DBE121F7E2CC5EC
                    identifier:
                      type: string
                      example: invoice_due
                    template:
                      type: string
                      example: Template do email
                    subject:
                      type: string
                      example: Assunto do email
                    active:
                      type: boolean
                      example: true
                      default: true
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Emails
  /emails/preview/{identifier}:
    get:
      summary: Visualizar Template de E-mail
      description: Retorna template salvo para determinado e-mail
      operationId: visualizar-templade-de-email
      parameters:
      - name: identifier
        in: path
        description: Identificador do Email
        schema:
          type: string
        required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n    \"preview\": \"Template do email\"\n}"
              schema:
                type: object
                properties:
                  preview:
                    type: string
                    example: Template do email
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: "#E-mail não foi criado, por isso o erro#\n{\n    \"status\": \"500\",\n    \"error\": \"Internal Server Error\"\n}"
      deprecated: false
      tags:
      - Emails
  /emails/{id}:
    put:
      summary: Editar E-mail
      description: Altera um E-mail
      operationId: alterar-email
      parameters:
      - name: id
        in: path
        description: ID do Email
        schema:
          type: string
        required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                identifier:
                  type: string
                  description: Identificador do email (Deve ser enviado um dos itens retornados pela API de 'Listar Emails Disponíveis')
                template:
                  type: string
                  description: Template do email
                subject:
                  type: string
                  description: Assunto do email
                active:
                  type: string
                  description: Determina se o email ficará ativo ou não
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n    \"id\": \"AB96E518FD9F48439D65B07A12E8D594\",\n    \"identifier\": \"subscription_charge_failure\",\n    \"template\": \"Template do email\",\n    \"subject\": \"Assunto do email\",\n    \"active\": true\n}"
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: AB96E518FD9F48439D65B07A12E8D594
                  identifier:
                    type: string
                    example: subscription_charge_failure
                  template:
                    type: string
                    example: Template do email
                  subject:
                    type: string
                    example: Assunto do email
                  active:
                    type: boolean
                    example: true
                    default: true
        '404':
          description: '404'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n    \"errors\": \"Account email Not Found\"\n}"
              schema:
                type: object
                properties:
                  errors:
                    type: string
                    example: Account email Not Found
      deprecated: false
      tags:
      - Emails
    delete:
      summary: Deletar E-mail
      description: Remove um e-mail
      operationId: remover-email
      parameters:
      - name: id
        in: path
        description: ID do Email
        schema:
          type: string
        required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n    \"id\": \"AB96E518FD9F48439D65B07A12E8D594\",\n    \"identifier\": \"subscription_charge_failure\",\n    \"template\": \"Template do email\",\n    \"subject\": \"Assunto do email\",\n    \"active\": true\n}"
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: AB96E518FD9F48439D65B07A12E8D594
                  identifier:
                    type: string
                    example: subscription_charge_failure
                  template:
                    type: string
                    example: Template do email
                  subject:
                    type: string
                    example: Assunto do email
                  active:
                    type: boolean
                    example: true
                    default: true
        '404':
          description: '404'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n    \"errors\": \"Account email Not Found\"\n}"
              schema:
                type: object
                properties:
                  errors:
                    type: string
                    example: Account email Not Found
      deprecated: false
      tags:
      - Emails
    get:
      summary: Buscar E-mail
      description: Retorna os dados de um determinado e-mail.
      operationId: buscar-email
      parameters:
      - name: id
        in: path
        description: ID do Email
        schema:
          type: string
        required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n    \"id\": \"10FFAE07CC004C5EBBBA2B9E1565704A\",\n    \"identifier\": \"subscription_trial_remainder\",\n    \"template\": \"Template do email\",\n    \"subject\": \"Assunto do email\",\n    \"active\": true\n}"
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: 10FFAE07CC004C5EBBBA2B9E1565704A
                  identifier:
                    type: string
                    example: subscription_trial_remainder
                  template:
                    type: string
                    example: Template do email
                  subject:
                    type: string
                    example: Assunto do email
                  active:
                    type: boolean
                    example: true
                    default: true
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n    \"errors\": \"Account email Not Found\"\n}\n#ID informado invalido #"
      deprecated: false
      tags:
      - Emails
components:
  securitySchemes:
    sec0:
      type: apiKey
      in: query
      name: api_token
x-readme-fauxas: true
x-provenance:
  method: searched
  source: https://dev.iugu.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://dev.iugu.com/reference/alterar-email.md
  - https://dev.iugu.com/reference/buscar-email.md
  - https://dev.iugu.com/reference/criar-email.md
  - https://dev.iugu.com/reference/listar-emails.md
  - https://dev.iugu.com/reference/remover-email.md
  - https://dev.iugu.com/reference/visualizar-templade-de-email.md
  merge:
    pages: 6
    deduped: 5
    conflicts_kept_first: 0