Unlock Protocol Email API
The Email API from Unlock Protocol — 3 operation(s) for 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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/unlock-protocol-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
openapi: 3.2.0
info:
title: Unlock Locksmith Applications Email API
version: '2'
description: Locksmith provides backend functionality for enabling ticketing, metadata storage, and notification hooks.
license:
name: MIT
servers:
- url: https://locksmith.unlock-protocol.com
description: Production Server
- url: https://staging-locksmith.unlock-protocol.com
description: Staging Server
tags:
- name: Email
paths:
/v2/email/{network}/locks/{lockAddress}/custom/{template}:
get:
operationId: getCustomEmailContent
security:
- User: []
description: Get custom email content for a specific template and lock details
parameters:
- $ref: '#/components/parameters/Network'
- $ref: '#/components/parameters/LockAddress'
- $ref: '#/components/parameters/TemplateId'
responses:
200:
description: Successfully get custom template content
content:
application/json:
schema:
type: object
properties:
lockAddress:
type: string
network:
type: number
template:
type: string
content:
type: string
500:
description: Could not get custom email content.
content:
application/json:
schema:
type: object
required:
- message
properties:
message:
type: string
401:
$ref: '#/components/responses/401.NotAuthenticated'
404:
description: Custom email content not found for this template.
tags:
- Email
post:
operationId: saveCustomEmailContent
security:
- User: []
description: Save custom email content for a specif lock.
parameters:
- $ref: '#/components/parameters/Network'
- $ref: '#/components/parameters/LockAddress'
- $ref: '#/components/parameters/TemplateId'
responses:
200:
description: Custom email content successfully saved.
content:
application/json:
schema:
type: object
properties:
lockAddress:
type: string
network:
type: number
template:
type: string
content:
type: string
500:
description: Could not save custom email content.
content:
application/json:
schema:
type: object
required:
- message
properties:
message:
type: string
401:
$ref: '#/components/responses/401.NotAuthenticated'
tags:
- Email
/v2/email/{network}/locks/{lockAddress}/custom/send:
post:
operationId: sendCustomEmail
security:
- User: []
description: Send custom email to recipients
parameters:
- $ref: '#/components/parameters/Network'
- $ref: '#/components/parameters/LockAddress'
requestBody:
content:
application/json:
schema:
type: object
properties:
subject:
type: string
content:
type: string
responses:
200:
description: Successfully sent custom email
content:
application/json:
schema:
type: object
properties:
sent:
type: boolean
400:
$ref: '#/components/responses/400.Invalid'
500:
$ref: '#/components/responses/500.InternalError'
tags:
- Email
/v2/email/{slug}/invite:
post:
operationId: sendEventInvites
security:
- User: []
description: Send event invites to a list of recipients
parameters:
- $ref: '#/components/parameters/Slug'
requestBody:
content:
application/json:
schema:
type: object
properties:
recipients:
type: array
items:
type: string
minItems: 1
maxItems: 10
responses:
200:
description: Successfully sent invites!
content:
application/json:
schema:
type: object
properties:
sent:
type: boolean
400:
$ref: '#/components/responses/400.Invalid'
500:
$ref: '#/components/responses/500.InternalError'
tags:
- Email
components:
parameters:
TemplateId:
in: path
name: template
required: true
description: Template id for email
schema:
type: string
LockAddress:
in: path
name: lockAddress
required: true
description: Lock address.
schema:
type: string
Slug:
in: path
name: slug
required: true
description: Slug
schema:
type: string
Network:
in: path
name: network
required: true
description: Network id.
schema:
type: integer
schemas:
GenericInvalidBodyError:
type: object
properties:
message:
type: string
default: Response body schema is invalid.
error:
type:
- string
- 'null'
GenericServerError:
type: object
properties:
message:
type: string
default: There was an error in fullfiling the request.
responses:
500.InternalError:
description: Unable to fullfil request due to internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/GenericServerError'
401.NotAuthenticated:
description: User is not authenticated.
content:
application:
schema:
$ref: '#/components/schemas/GenericServerError'
400.Invalid:
description: Invalid input received. Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/GenericInvalidBodyError'
securitySchemes:
User:
type: http
scheme: bearer
bearerFormat: JWT
Application:
type: apiKey
name: api-key
in: query