Openprovider Email API

The Email API from Openprovider — 2 operation(s) for email.

Operations 4

GET /v1beta/emails List emails #
POST /v1beta/emails Create email #
PUT /v1beta/emails/{id} Update email #
DELETE /v1beta/emails/{id} Delete email #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/openprovider-email-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openprovider-email-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: REST AdditionalData Email API
  version: 1.0.0-beta
servers:
- url: https://api.openprovider.eu
security:
- Bearer: []
tags:
- name: Email
paths:
  /v1beta/emails:
    get:
      tags:
      - Email
      summary: List emails
      operationId: ListEmails
      parameters:
      - description: Object ID.
        name: id
        in: query
        schema:
          type: integer
          format: int32
      - description: Template name.
        name: name
        in: query
        schema:
          type: string
      - description: 'Email template type. There are several types of ICANN emails that can be customized in Openprovider: -errp (Expired Registration Recovery policy emails) -foa (Form of Authorization emails for domain transfers approval rejection) -ive (Information verification emails, such emails used to verify email address of the customer) -tcn (Trademark Claims Notification emails) -wdrp (Whois Data Reminder Policy emails).'
        name: group
        in: query
        schema:
          type: string
      - description: Output limit.
        name: limit
        in: query
        schema:
          type: integer
          format: int32
      - description: Output offset.
        name: offset
        in: query
        schema:
          type: integer
          format: int32
      - description: Is system.
        name: is_system
        in: query
        schema:
          type: boolean
          format: boolean
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/emailListEmailsResponse'
        default:
          description: (empty)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorError'
    post:
      tags:
      - Email
      summary: Create email
      operationId: CreateEmail
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/emailCreateEmailResponse'
        default:
          description: (empty)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/emailCreateEmailRequest'
        required: true
  /v1beta/emails/{id}:
    put:
      tags:
      - Email
      summary: Update email
      operationId: UpdateEmail
      parameters:
      - description: Object ID
        name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/emailUpdateEmailResponse'
        default:
          description: (empty)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/emailUpdateEmailRequest'
        required: true
    delete:
      tags:
      - Email
      summary: Delete email
      operationId: DeleteEmail
      parameters:
      - description: Object ID
        name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/emailDeleteEmailResponse'
        default:
          description: (empty)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorError'
components:
  schemas:
    emailFields:
      type: object
      title: Fields
      properties:
        name:
          type: string
          title: Template name
        value:
          type: string
          title: The value of the tag. I.e.:VIP customer
      example:
        name: senderEmail
        value: support@resellerA.com
    emailDeleteEmailResponse:
      type: object
      title: DeleteEmailResponse
      properties:
        code:
          type: integer
          format: int32
          title: Response code
        data:
          title: Response data
          $ref: '#/components/schemas/emailDeleteEmailResponseData'
        desc:
          type: string
          title: Response description
        maintenance:
          type: boolean
          format: boolean
          title: Indicates, if Openprovider API is on maintenance
        warnings:
          type: array
          title: Array of warning messages
          items:
            $ref: '#/components/schemas/errorWarning'
      example:
        code: 0
        data:
          success: false
        desc: ''
    emailListEmailsResponseData:
      type: object
      title: ListEmailsResponseData
      properties:
        results:
          type: array
          title: Array of results
          items:
            $ref: '#/components/schemas/emailListEmailsResponseDataResults'
        total:
          type: integer
          format: int32
          title: Results count
      example:
        results:
        - fields:
          - name: senderEmail
            value: support@resellerA.com
          group: ive
          id: 0
          is_active: false
          is_default: false
          locale:
          - nl_NL
          name: ''
          tags:
          - key: customer
            value: Reseller A
        total: 999
    emailCreateEmailResponseData:
      type: object
      title: CreateEmailResponseData
      properties:
        id:
          type: integer
          format: int32
          title: Object ID
      example:
        id: 0
    emailUpdateEmailResponseData:
      type: object
      title: UpdateEmailResponseData
      properties:
        success:
          type: boolean
          format: boolean
          title: Indicates, if operation was successfull
      example:
        success: false
    emailTags:
      type: object
      title: Tags
      properties:
        key:
          type: string
          title: 'The key of the tag. Allowed values: ''customer'''
        value:
          type: string
          title: The value of the tag. I.e.:VIP customer
      example:
        key: customer
        value: Reseller A
    emailUpdateEmailRequest:
      type: object
      title: UpdateEmailRequest
      properties:
        fields:
          type: array
          title: Array of template fields and values
          items:
            $ref: '#/components/schemas/emailFields'
        group:
          type: string
          title: The group
        id:
          type: integer
          format: int32
          title: Object ID
        is_active:
          type: boolean
          format: boolean
          title: Indicates, if template is active
        is_default:
          type: boolean
          format: boolean
          title: Indicates, if template is used by default
        locale:
          type: array
          title: Template language. All supported codes http://demo.icu-project.org/icu-bin/locexp
          items:
            type: string
        name:
          type: string
          title: The name
        tags:
          type: array
          title: This parameter is optional and allows you to specify a specific tags for object
          items:
            $ref: '#/components/schemas/emailTags'
      example:
        fields:
        - name: senderEmail
          value: support@resellerA.com
        group: ''
        id: 0
        is_active: false
        is_default: false
        locale:
        - nl_NL
        name: ''
        tags:
        - key: customer
          value: Reseller A
    emailDeleteEmailResponseData:
      type: object
      title: DeleteEmailResponseData
      properties:
        success:
          type: boolean
          format: boolean
          title: Indicates, if operation was successfull
      example:
        success: false
    emailCreateEmailResponse:
      type: object
      title: CreateEmailResponse
      properties:
        code:
          type: integer
          format: int32
          title: Response code
        data:
          title: Response data
          $ref: '#/components/schemas/emailCreateEmailResponseData'
        desc:
          type: string
          title: Response description
        maintenance:
          type: boolean
          format: boolean
          title: Indicates, if Openprovider API is on maintenance
        warnings:
          type: array
          title: Array of warning messages
          items:
            $ref: '#/components/schemas/errorWarning'
      example:
        code: 0
        data:
          id: 0
        desc: ''
    emailListEmailsResponse:
      type: object
      title: ListEmailsResponse
      properties:
        code:
          type: integer
          format: int32
          title: Response code
        data:
          title: Response data
          $ref: '#/components/schemas/emailListEmailsResponseData'
        desc:
          type: string
          title: Response description
        maintenance:
          type: boolean
          format: boolean
          title: Indicates, if Openprovider API is on maintenance
        warnings:
          type: array
          title: Array of warning messages
          items:
            $ref: '#/components/schemas/errorWarning'
      example:
        code: 0
        data:
          results:
          - fields:
            - name: senderEmail
              value: support@resellerA.com
            group: ive
            id: 0
            is_active: false
            is_default: false
            locale:
            - nl_NL
            name: ''
            tags:
            - key: customer
              value: Reseller A
          total: 999
        desc: ''
    emailCreateEmailRequest:
      type: object
      title: CreateEmailRequest
      properties:
        fields:
          type: array
          title: Array of template fields and values
          items:
            $ref: '#/components/schemas/emailFields'
        group:
          type: string
          title: 'Email template type. There are several types of ICANN emails that can be customized in Openprovider: -errp (Expired Registration Recovery policy emails) -foa (Form of Authorization emails for domain transfers approval \ rejection) -ive (Information verification emails, such emails used to verify email address of the customer) -tcn (Trademark Claims Notification emails) -wdrp (Whois Data Reminder Policy emails)'
        is_active:
          type: boolean
          format: boolean
          title: Indicates, if template is active
        is_default:
          type: boolean
          format: boolean
          title: Indicates, if template is used by default
        locale:
          type: array
          title: Template language. All supported codes http://demo.icu-project.org/icu-bin/locexp
          items:
            type: string
        name:
          type: string
          title: Template name
        tags:
          type: array
          title: This parameter is optional and allows you to specify a specific tags for object
          items:
            $ref: '#/components/schemas/emailTags'
      example:
        fields:
        - name: senderEmail
          value: support@resellerA.com
        group: wdrp
        is_active: false
        is_default: false
        locale:
        - nl_NL
        name: ''
        tags:
        - key: customer
          value: Reseller A
    errorError:
      type: object
      title: Error
      properties:
        code:
          type: integer
          format: int32
          title: Error code
        data:
          type: string
          title: Additional error description
        desc:
          type: string
          title: Error description
      example:
        code: 0
        data: ''
        desc: ''
    emailUpdateEmailResponse:
      type: object
      title: UpdateEmailResponse
      properties:
        code:
          type: integer
          format: int32
          title: Response code
        data:
          title: Response data
          $ref: '#/components/schemas/emailUpdateEmailResponseData'
        desc:
          type: string
          title: Response description
        maintenance:
          type: boolean
          format: boolean
          title: Indicates, if Openprovider API is on maintenance
        warnings:
          type: array
          title: Array of warning messages
          items:
            $ref: '#/components/schemas/errorWarning'
      example:
        code: 0
        data:
          success: false
        desc: ''
    emailListEmailsResponseDataResults:
      type: object
      title: ListEmailsResponseDataResults
      properties:
        fields:
          type: array
          title: Array of template fields and values
          items:
            $ref: '#/components/schemas/emailFields'
        group:
          type: string
          title: 'Email template type. There are several types of ICANN emails that can be customized in Openprovider: -errp (Expired Registration Recovery policy emails) -foa (Form of Authorization emails for domain transfers approval \ rejection) -ive (Information verification emails, such emails used to verify email address of the customer) -tcn (Trademark Claims Notification emails) -wdrp (Whois Data Reminder Policy emails)'
        id:
          type: integer
          format: int32
          title: Object ID
        is_active:
          type: boolean
          format: boolean
          title: Indicates, if template is active
        is_default:
          type: boolean
          format: boolean
          title: Indicates, if template is used by default
        locale:
          type: array
          title: Template language. All supported codes http://demo.icu-project.org/icu-bin/locexp
          items:
            type: string
        name:
          type: string
          title: Template name
        tags:
          type: array
          title: This parameter is optional and allows you to specify a specific tags for object
          items:
            $ref: '#/components/schemas/emailTags'
      example:
        fields:
        - name: senderEmail
          value: support@resellerA.com
        group: ive
        id: 0
        is_active: false
        is_default: false
        locale:
        - nl_NL
        name: ''
        tags:
        - key: customer
          value: Reseller A
    errorWarning:
      type: object
      title: Warning
      properties:
        code:
          type: integer
          format: int32
          title: Warning code
        data:
          type: string
          title: Additional warning description
        desc:
          type: string
          title: Warning description
      example:
        code: 0
        data: ''
        desc: ''
  securitySchemes:
    Bearer:
      type: apiKey
      name: Authorization
      in: header
      x-linkTo: tag/descAuthentication
x-tagGroups:
- name: Introduction
  tags:
  - descAbout
  - descGettingStarted
  - descEndpoints
  - descAuthentication
- name: Quick Start
  tags:
  - descCustomerQuickstart
  - descDomainQuickstart
  - descTLDQuickstart
  - descDNSQuickstart
  - descSSLQuickstart
- name: Auth
  tags:
  - Auth
  - SpamExpert
- name: Billing
  tags:
  - InvoiceService
  - Payment
  - Transaction
- name: DNS
  tags:
  - DomainToken
  - NameserverService
  - NsGroupService
  - TemplateService
  - ZoneService
  - ZoneRecordService
- name: Domain
  tags:
  - DomainService
  - AdditionalData
  - CustomerAdditionalData
  - DomainPriceService
  - AuthCode
  - TldService
- name: EasyDmarc
  tags:
  - EasydmarcOrder
- name: Email template
  tags:
  - Email
- name: License
  tags:
  - LicenseService
- name: Reseller/Customer
  tags:
  - ContactService
  - Customer
  - EmailVerification
  - ResellerService
  - Settings
  - Statistics
  - TagService
- name: Spam Experts
  tags:
  - SEDomain
- name: SSL
  tags:
  - ApproverEmail
  - Csr
  - Order
  - OrderApproverEmail
  - OtpToken
  - Product