addy.io Alias Bulk Actions API
The Alias Bulk Actions API from addy.io — 10 operation(s) for alias bulk actions.
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/addy-io:addy-io-alias-bulk-actions-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: addy.io API Documentation Alias Bulk Actions API
description: ''
version: 1.0.0
servers:
- url: https://app.addy.io
security:
- default: []
tags:
- name: Alias Bulk Actions
description: ''
paths:
/api/v1/aliases/get/bulk:
post:
summary: Bulk Get Specific Aliases
operationId: bulkGetSpecificAliases
description: This endpoint gets specific aliases.
parameters:
- in: header
name: X-Requested-With
description: ''
example: XMLHttpRequest
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
- id: 50c9e585-e7f5-41c4-9016-9014c15454bc
user_id: ca0a4e09-c266-4f6f-845c-958db5090f09
aliasable_id: null
aliasable_type: null
local_part: first
extension: null
domain: johndoe.anonaddy.com
email: first@johndoe.anonaddy.com
active: true
pinned: false
description: null
from_name: null
attached_recipients_only: false
emails_forwarded: 5
emails_blocked: 0
emails_replied: 0
emails_sent: 0
recipients: []
labels: []
last_forwarded: '2019-10-01 09:00:00'
last_blocked: null
last_replied: null
last_sent: null
created_at: '2019-10-01 09:00:00'
updated_at: '2019-10-01 09:00:00'
deleted_at: null
- id: c549db7d-5fac-4b09-9443-9e47f644d29f
user_id: ca0a4e09-c266-4f6f-845c-958db5090f09
domain_id: null
local_part: second
extension: null
domain: johndoe.anonaddy.com
email: second@johndoe.anonaddy.com
active: true
pinned: false
description: null
from_name: null
attached_recipients_only: false
emails_forwarded: 2
emails_blocked: 1
emails_replied: 0
emails_sent: 0
recipients: []
labels: []
last_forwarded: '2019-10-01 09:00:00'
last_blocked: null
last_replied: null
last_sent: null
created_at: '2019-10-01 09:00:00'
updated_at: '2019-10-01 09:00:00'
deleted_at: null
properties:
data:
type: array
example:
- id: 50c9e585-e7f5-41c4-9016-9014c15454bc
user_id: ca0a4e09-c266-4f6f-845c-958db5090f09
aliasable_id: null
aliasable_type: null
local_part: first
extension: null
domain: johndoe.anonaddy.com
email: first@johndoe.anonaddy.com
active: true
pinned: false
description: null
from_name: null
attached_recipients_only: false
emails_forwarded: 5
emails_blocked: 0
emails_replied: 0
emails_sent: 0
recipients: []
labels: []
last_forwarded: '2019-10-01 09:00:00'
last_blocked: null
last_replied: null
last_sent: null
created_at: '2019-10-01 09:00:00'
updated_at: '2019-10-01 09:00:00'
deleted_at: null
- id: c549db7d-5fac-4b09-9443-9e47f644d29f
user_id: ca0a4e09-c266-4f6f-845c-958db5090f09
domain_id: null
local_part: second
extension: null
domain: johndoe.anonaddy.com
email: second@johndoe.anonaddy.com
active: true
pinned: false
description: null
from_name: null
attached_recipients_only: false
emails_forwarded: 2
emails_blocked: 1
emails_replied: 0
emails_sent: 0
recipients: []
labels: []
last_forwarded: '2019-10-01 09:00:00'
last_blocked: null
last_replied: null
last_sent: null
created_at: '2019-10-01 09:00:00'
updated_at: '2019-10-01 09:00:00'
deleted_at: null
items:
type: object
properties:
id:
type: string
example: 50c9e585-e7f5-41c4-9016-9014c15454bc
user_id:
type: string
example: ca0a4e09-c266-4f6f-845c-958db5090f09
aliasable_id:
type:
- string
- 'null'
example: null
aliasable_type:
type:
- string
- 'null'
example: null
local_part:
type: string
example: first
extension:
type:
- string
- 'null'
example: null
domain:
type: string
example: johndoe.anonaddy.com
email:
type: string
example: first@johndoe.anonaddy.com
active:
type: boolean
example: true
pinned:
type: boolean
example: false
description:
type:
- string
- 'null'
example: null
from_name:
type:
- string
- 'null'
example: null
attached_recipients_only:
type: boolean
example: false
emails_forwarded:
type: integer
example: 5
emails_blocked:
type: integer
example: 0
emails_replied:
type: integer
example: 0
emails_sent:
type: integer
example: 0
recipients:
type: array
example: []
labels:
type: array
example: []
last_forwarded:
type: string
example: '2019-10-01 09:00:00'
last_blocked:
type:
- string
- 'null'
example: null
last_replied:
type:
- string
- 'null'
example: null
last_sent:
type:
- string
- 'null'
example: null
created_at:
type: string
example: '2019-10-01 09:00:00'
updated_at:
type: string
example: '2019-10-01 09:00:00'
deleted_at:
type:
- string
- 'null'
example: null
tags:
- Alias Bulk Actions
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
ids:
type: array
description: An array of the alias ids (max 25)
example:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
items:
type: string
required:
- ids
/api/v1/aliases/activate/bulk:
post:
summary: Bulk Activate Specific Aliases
operationId: bulkActivateSpecificAliases
description: This endpoint activates specific aliases.
parameters:
- in: header
name: X-Requested-With
description: ''
example: XMLHttpRequest
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
message: 2 aliases activated successfully
ids:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
properties:
data:
type: object
properties:
message:
type: string
example: 2 aliases activated successfully
ids:
type: array
example:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
items:
type: string
tags:
- Alias Bulk Actions
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
ids:
type: array
description: An array of the alias ids (max 25)
example:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
items:
type: string
required:
- ids
/api/v1/aliases/deactivate/bulk:
post:
summary: Bulk Deactivate Specific Aliases
operationId: bulkDeactivateSpecificAliases
description: This endpoint deactivates specific aliases.
parameters:
- in: header
name: X-Requested-With
description: ''
example: XMLHttpRequest
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
message: 2 aliases deactivated successfully
ids:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
properties:
data:
type: object
properties:
message:
type: string
example: 2 aliases deactivated successfully
ids:
type: array
example:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
items:
type: string
tags:
- Alias Bulk Actions
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
ids:
type: array
description: An array of the alias ids (max 25)
example:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
items:
type: string
required:
- ids
/api/v1/aliases/pin/bulk:
post:
summary: Bulk Pin Specific Aliases
operationId: bulkPinSpecificAliases
description: This endpoint pins specific aliases so they appear first when listing.
parameters:
- in: header
name: X-Requested-With
description: ''
example: XMLHttpRequest
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
message: 2 aliases pinned successfully
ids:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
properties:
data:
type: object
properties:
message:
type: string
example: 2 aliases pinned successfully
ids:
type: array
example:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
items:
type: string
tags:
- Alias Bulk Actions
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
ids:
type: array
description: An array of the alias ids (max 25)
example:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
items:
type: string
required:
- ids
/api/v1/aliases/unpin/bulk:
post:
summary: Bulk Unpin Specific Aliases
operationId: bulkUnpinSpecificAliases
description: This endpoint unpins specific aliases.
parameters:
- in: header
name: X-Requested-With
description: ''
example: XMLHttpRequest
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
message: 2 aliases unpinned successfully
ids:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
properties:
data:
type: object
properties:
message:
type: string
example: 2 aliases unpinned successfully
ids:
type: array
example:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
items:
type: string
tags:
- Alias Bulk Actions
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
ids:
type: array
description: An array of the alias ids (max 25)
example:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
items:
type: string
required:
- ids
/api/v1/aliases/delete/bulk:
post:
summary: Bulk Delete Specific Aliases
operationId: bulkDeleteSpecificAliases
description: This endpoint deletes specific aliases.
parameters:
- in: header
name: X-Requested-With
description: ''
example: XMLHttpRequest
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
message: 2 aliases deleted successfully
ids:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
properties:
data:
type: object
properties:
message:
type: string
example: 2 aliases deleted successfully
ids:
type: array
example:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
items:
type: string
tags:
- Alias Bulk Actions
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
ids:
type: array
description: An array of the alias ids (max 25)
example:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
items:
type: string
required:
- ids
/api/v1/aliases/restore/bulk:
post:
summary: Bulk Restore Specific Aliases
operationId: bulkRestoreSpecificAliases
description: This endpoint restores specific aliases.
parameters:
- in: header
name: X-Requested-With
description: ''
example: XMLHttpRequest
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
message: 2 aliases restored successfully
ids:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
properties:
data:
type: object
properties:
message:
type: string
example: 2 aliases restored successfully
ids:
type: array
example:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
items:
type: string
tags:
- Alias Bulk Actions
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
ids:
type: array
description: An array of the alias ids (max 25)
example:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
items:
type: string
required:
- ids
/api/v1/aliases/forget/bulk:
post:
summary: Bulk Forget Specific Aliases
operationId: bulkForgetSpecificAliases
description: This endpoint forgets specific aliases.
parameters:
- in: header
name: X-Requested-With
description: ''
example: XMLHttpRequest
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
message: 2 aliases forgotten successfully
ids:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
properties:
data:
type: object
properties:
message:
type: string
example: 2 aliases forgotten successfully
ids:
type: array
example:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
items:
type: string
tags:
- Alias Bulk Actions
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
ids:
type: array
description: An array of the alias ids (max 25)
example:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
items:
type: string
required:
- ids
/api/v1/aliases/recipients/bulk:
post:
summary: Bulk Update Recipients for Specific Aliases
operationId: bulkUpdateRecipientsForSpecificAliases
description: This endpoint updates the recipients for specific aliases.
parameters:
- in: header
name: X-Requested-With
description: ''
example: XMLHttpRequest
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
message: recipients updated for 2 aliases successfully
ids:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
properties:
data:
type: object
properties:
message:
type: string
example: recipients updated for 2 aliases successfully
ids:
type: array
example:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
items:
type: string
tags:
- Alias Bulk Actions
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
ids:
type: array
description: An array of the alias ids (max 25)
example:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
items:
type: string
recipient_ids:
type: array
description: An array of recipient ids to add
example:
- 46eebc50-f7f8-46d7-beb9-c37f04c29a84
items:
type: string
family_member_ids:
type: array
description: User ids of Duo or Family plan members. Omit this field to leave existing family deliveries unchanged.
example:
- architecto
items:
type: string
family_reply_send_ids:
type: array
description: User ids, from family_member_ids, who may reply and send from every selected alias. Omit this field to leave reply and send off when family_member_ids is sent.
example:
- architecto
items:
type: string
required:
- ids
- recipient_ids
/api/v1/aliases/labels/bulk:
post:
summary: Bulk Update Labels for Specific Aliases
operationId: bulkUpdateLabelsForSpecificAliases
description: This endpoint updates the labels for specific aliases.
parameters:
- in: header
name: X-Requested-With
description: ''
example: XMLHttpRequest
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: labels updated for 2 aliases successfully
ids:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
properties:
message:
type: string
example: labels updated for 2 aliases successfully
ids:
type: array
example:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
- c549db7d-5fac-4b09-9443-9e47f644d29f
items:
type: string
tags:
- Alias Bulk Actions
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
ids:
type: array
description: An array of the alias ids (max 25)
example:
- 50c9e585-e7f5-41c4-9016-9014c15454bc
items:
type: string
label_ids:
type: array
description: An array of label ids to attach
example:
- 46eebc50-f7f8-46d7-beb9-c37f04c29a84
items:
type: string
required:
- ids
- label_ids
components:
securitySchemes:
default:
type: http
scheme: bearer
description: You can retrieve your API key by visiting your <a href="https://app.addy.io/settings/api">account settings</a> and clicking <b>Create New API Key</b>.