{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/app.addy.io" } ], "info": { "name": "addy.io API Documentation", "_postman_id": "8432d709-a018-4b3f-8f81-3678f57dae1c", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "API Token", "description": "", "item": [ { "name": "Get details about the current API token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/api-token-details", "query": [], "raw": "{{baseUrl}}\/api\/v1\/api-token-details" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves details about the current API token." }, "response": [ { "header": [], "code": 200, "body": "{\n\t\"name\": \"Firefox Extension\",\n\t\"created_at\": \"2019-10-01 09:00:00\",\n\t\"expires_at\": null\n}", "name": "" } ] } ] }, { "name": "Account Details", "description": "", "item": [ { "name": "Get All Account Details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/account-details", "query": [], "raw": "{{baseUrl}}\/api\/v1\/account-details" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves all account details." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"50c9e585-e7f5-41c4-9016-9014c15454bc\",\n \"username\": \"johndoe\",\n \"from_name\": \"John Doe\",\n \"email_subject\": \"Private Subject\",\n \"banner_location\": \"off\",\n \"bandwidth\": 10485760,\n \"username_count\": 2,\n \"username_limit\": 3,\n \"default_recipient_id\": \"46eebc50-f7f8-46d7-beb9-c37f04c29a84\",\n \"default_alias_domain\": \"anonaddy.me\",\n \"default_alias_format\": \"random_words\",\n \"subscription\": \"pro\",\n \"subscription_ends_at\": null,\n \"bandwidth_limit\": 0,\n \"recipient_count\": 12,\n \"recipient_limit\": 20,\n \"active_domain_count\": 4,\n \"active_domain_limit\": 10,\n \"active_shared_domain_alias_count\": 50,\n \"active_shared_domain_alias_limit\": 0,\n \"active_rule_count\": 4,\n \"active_rule_limit\": 5,\n \"total_emails_forwarded\": 488,\n \"total_emails_blocked\": 6,\n \"total_emails_replied\": 95,\n \"total_emails_sent\": 17,\n \"total_aliases\": 529,\n \"total_active_aliases\": 481,\n \"total_inactive_aliases\": 19,\n \"total_deleted_aliases\": 29,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n ]\n}", "name": "" } ] } ] }, { "name": "Account Notifications", "description": "", "item": [ { "name": "Get All Account Notifications", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/account-notifications", "query": [], "raw": "{{baseUrl}}\/api\/v1\/account-notifications" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves all account notifications." }, "response": [ { "header": [], "code": 200, "body": "{\n\t\"id\": \"a83b1763-7a63-4306-93cd-3b2e051db704\",\n\t\"category\": \"Announcement\",\n\t\"title\": \"Notification title\",\n\t\"text\": \"Notification text\",\n\t\"link\": \"https:\/\/addy.io\/\",\n\t\"link_text\": \"Read More\",\n\t\"created_at\": \"2019-10-01 09:00:00\"\n}", "name": "" } ] } ] }, { "name": "Alias Bulk Actions", "description": "", "item": [ { "name": "Bulk Get Specific Aliases", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/aliases\/get\/bulk", "query": [], "raw": "{{baseUrl}}\/api\/v1\/aliases\/get\/bulk" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ids\":[\"50c9e585-e7f5-41c4-9016-9014c15454bc\",\"c549db7d-5fac-4b09-9443-9e47f644d29f\"]}" }, "description": "This endpoint gets specific aliases." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"50c9e585-e7f5-41c4-9016-9014c15454bc\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"aliasable_id\": null,\n \"aliasable_type\": null,\n \"local_part\": \"first\",\n \"extension\": null,\n \"domain\": \"johndoe.anonaddy.com\",\n \"email\": \"first@johndoe.anonaddy.com\",\n \"active\": true,\n \"description\": null,\n \"from_name\": null,\n \"attached_recipients_only\": false,\n \"emails_forwarded\": 5,\n \"emails_blocked\": 0,\n \"emails_replied\": 0,\n \"emails_sent\": 0,\n \"recipients\": [],\n \"last_forwarded\": \"2019-10-01 09:00:00\",\n \"last_blocked\" : null,\n \"last_replied\" : null,\n \"last_sent\" : null,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\",\n \"deleted_at\": null\n },\n {\n \"id\": \"c549db7d-5fac-4b09-9443-9e47f644d29f\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"domain_id\": null,\n \"local_part\": \"second\",\n \"extension\": null,\n \"domain\": \"johndoe.anonaddy.com\",\n \"email\": \"second@johndoe.anonaddy.com\",\n \"active\": true,\n \"description\": null,\n \"from_name\": null,\n \"attached_recipients_only\": false,\n \"emails_forwarded\": 2,\n \"emails_blocked\": 1,\n \"emails_replied\": 0,\n \"emails_sent\": 0,\n \"recipients\": [],\n \"last_forwarded\": \"2019-10-01 09:00:00\",\n \"last_blocked\" : null,\n \"last_replied\" : null,\n \"last_sent\" : null,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\",\n \"deleted_at\": null\n }\n ]\n}", "name": "" } ] }, { "name": "Bulk Activate Specific Aliases", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/aliases\/activate\/bulk", "query": [], "raw": "{{baseUrl}}\/api\/v1\/aliases\/activate\/bulk" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ids\":[\"50c9e585-e7f5-41c4-9016-9014c15454bc\",\"c549db7d-5fac-4b09-9443-9e47f644d29f\"]}" }, "description": "This endpoint activates specific aliases." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"message\": \"2 aliases activated successfully\",\n \"ids\": [\"50c9e585-e7f5-41c4-9016-9014c15454bc\", \"c549db7d-5fac-4b09-9443-9e47f644d29f\"]\n }\n}", "name": "" } ] }, { "name": "Bulk Deactivate Specific Aliases", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/aliases\/deactivate\/bulk", "query": [], "raw": "{{baseUrl}}\/api\/v1\/aliases\/deactivate\/bulk" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ids\":[\"50c9e585-e7f5-41c4-9016-9014c15454bc\",\"c549db7d-5fac-4b09-9443-9e47f644d29f\"]}" }, "description": "This endpoint deactivates specific aliases." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"message\": \"2 aliases deactivated successfully\",\n \"ids\": [\"50c9e585-e7f5-41c4-9016-9014c15454bc\", \"c549db7d-5fac-4b09-9443-9e47f644d29f\"]\n }\n}", "name": "" } ] }, { "name": "Bulk Delete Specific Aliases", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/aliases\/delete\/bulk", "query": [], "raw": "{{baseUrl}}\/api\/v1\/aliases\/delete\/bulk" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ids\":[\"50c9e585-e7f5-41c4-9016-9014c15454bc\",\"c549db7d-5fac-4b09-9443-9e47f644d29f\"]}" }, "description": "This endpoint deletes specific aliases." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"message\": \"2 aliases deleted successfully\",\n \"ids\": [\"50c9e585-e7f5-41c4-9016-9014c15454bc\", \"c549db7d-5fac-4b09-9443-9e47f644d29f\"]\n }\n}", "name": "" } ] }, { "name": "Bulk Restore Specific Aliases", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/aliases\/restore\/bulk", "query": [], "raw": "{{baseUrl}}\/api\/v1\/aliases\/restore\/bulk" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ids\":[\"50c9e585-e7f5-41c4-9016-9014c15454bc\",\"c549db7d-5fac-4b09-9443-9e47f644d29f\"]}" }, "description": "This endpoint restores specific aliases." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"message\": \"2 aliases restored successfully\",\n \"ids\": [\"50c9e585-e7f5-41c4-9016-9014c15454bc\", \"c549db7d-5fac-4b09-9443-9e47f644d29f\"]\n }\n}", "name": "" } ] }, { "name": "Bulk Destroy Specific Aliases", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/aliases\/destroy\/bulk", "query": [], "raw": "{{baseUrl}}\/api\/v1\/aliases\/destroy\/bulk" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ids\":[\"50c9e585-e7f5-41c4-9016-9014c15454bc\",\"c549db7d-5fac-4b09-9443-9e47f644d29f\"]}" }, "description": "This endpoint destroys specific aliases." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"message\": \"2 aliases forgotten successfully\",\n \"ids\": [\"50c9e585-e7f5-41c4-9016-9014c15454bc\", \"c549db7d-5fac-4b09-9443-9e47f644d29f\"]\n }\n}", "name": "" } ] }, { "name": "Bulk Update Recipients for Specific Aliases", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/aliases\/recipients\/bulk", "query": [], "raw": "{{baseUrl}}\/api\/v1\/aliases\/recipients\/bulk" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ids\":[\"50c9e585-e7f5-41c4-9016-9014c15454bc\",\"c549db7d-5fac-4b09-9443-9e47f644d29f\"],\"recipient_ids\":[\"46eebc50-f7f8-46d7-beb9-c37f04c29a84\"]}" }, "description": "This endpoint updates the recipients for specific aliases." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"message\": \"recipients updated for 2 aliases successfully\",\n \"ids\": [\"50c9e585-e7f5-41c4-9016-9014c15454bc\", \"c549db7d-5fac-4b09-9443-9e47f644d29f\"]\n }\n}", "name": "" } ] } ] }, { "name": "Aliases", "description": "", "item": [ { "name": "Get All Aliases", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/aliases", "query": [ { "key": "filter%5Bdeleted%5D", "value": "with", "description": "Choose to return alias with deleted or only deleted. Options: with, only.", "disabled": false }, { "key": "filter%5Bactive%5D", "value": "true", "description": "Choose to return active or inactive aliases. Options: true, false.", "disabled": false }, { "key": "filter%5Bsearch%5D", "value": "johndoe", "description": "Search aliases by email and description.", "disabled": false }, { "key": "sort", "value": "-email", "description": "Choose what to sort the aliases by, prepend \"-\" for descending results. Options: local_part, domain, email, emails_forwarded, emails_blocked, emails_replied, emails_sent, last_forwarded, last_blocked, last_replied, last_sent, last_used, active, created_at, updated_at, deleted_at", "disabled": false }, { "key": "page%5Bnumber%5D", "value": "1", "description": "Paginate the alias results.", "disabled": false }, { "key": "page%5Bsize%5D", "value": "10", "description": "Paginate the alias results, default 100, min 1 max 100.", "disabled": false }, { "key": "with", "value": "recipients", "description": "Return aliases with their attached recipients. Options: recipients", "disabled": false }, { "key": "recipient", "value": "46eebc50-f7f8-46d7-beb9-c37f04c29a84", "description": "Return aliases using the recipient with the specified ID.", "disabled": false }, { "key": "domain", "value": "0ad7a75a-1517-4b86-bb8a-9443d4965e60", "description": "Return aliases using the custom domain with the specified ID.", "disabled": false }, { "key": "username", "value": "2777dee6-1721-45c0-8d01-698b6be2335f", "description": "Return aliases using the username with the specified ID.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/aliases?filter%5Bdeleted%5D=with&filter%5Bactive%5D=true&filter%5Bsearch%5D=johndoe&sort=-email&page%5Bnumber%5D=1&page%5Bsize%5D=10&with=recipients&recipient=46eebc50-f7f8-46d7-beb9-c37f04c29a84&domain=0ad7a75a-1517-4b86-bb8a-9443d4965e60&username=2777dee6-1721-45c0-8d01-698b6be2335f" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves all aliases." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"50c9e585-e7f5-41c4-9016-9014c15454bc\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"aliasable_id\": null,\n \"aliasable_type\": null,\n \"local_part\": \"first\",\n \"extension\": null,\n \"domain\": \"johndoe.anonaddy.com\",\n \"email\": \"first@johndoe.anonaddy.com\",\n \"active\": true,\n \"description\": null,\n \"from_name\": null,\n \"attached_recipients_only\": false,\n \"emails_forwarded\": 5,\n \"emails_blocked\": 0,\n \"emails_replied\": 0,\n \"emails_sent\": 0,\n \"recipients\": [],\n \"last_forwarded\": \"2019-10-01 09:00:00\",\n \"last_blocked\" : null,\n \"last_replied\" : null,\n \"last_sent\" : null,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\",\n \"deleted_at\": null\n },\n {\n \"id\": \"c549db7d-5fac-4b09-9443-9e47f644d29f\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"domain_id\": null,\n \"local_part\": \"second\",\n \"extension\": null,\n \"domain\": \"johndoe.anonaddy.com\",\n \"email\": \"second@johndoe.anonaddy.com\",\n \"active\": true,\n \"description\": null,\n \"from_name\": null,\n \"attached_recipients_only\": false,\n \"emails_forwarded\": 2,\n \"emails_blocked\": 1,\n \"emails_replied\": 0,\n \"emails_sent\": 0,\n \"recipients\": [],\n \"last_forwarded\": \"2019-10-01 09:00:00\",\n \"last_blocked\" : null,\n \"last_replied\" : null,\n \"last_sent\" : null,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\",\n \"deleted_at\": null\n }\n ],\n \"links\": {\n \"first\": \"https:\\\/\\\/app.addy.io\\\/api\\\/v1\\\/aliases?filter%5Bdeleted%5D=with&filter%5Bsearch%5D=johndoe&page%5Bsize%5D=10&page%5Bnumber%5D=1\",\n \"last\": \"https:\\\/\\\/app.addy.io\\\/api\\\/v1\\\/aliases?filter%5Bdeleted%5D=with&filter%5Bsearch%5D=johndoe&page%5Bsize%5D=10&page%5Bnumber%5D=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https:\\\/\\\/app.addy.io\\\/api\\\/v1\\\/aliases?filter%5Bdeleted%5D=with&filter%5Bsearch%5D=johndoe&page%5Bsize%5D=10&page%5Bnumber%5D=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"https:\\\/\\\/app.addy.io\\\/api\\\/v1\\\/aliases\",\n \"per_page\": 10,\n \"to\": 2,\n \"total\": 2\n }\n}", "name": "" } ] }, { "name": "Get a Specific Alias", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/aliases\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/aliases\/:id", "variable": [ { "id": "id", "key": "id", "value": "50c9e585-e7f5-41c4-9016-9014c15454bc", "description": "The id of the alias to retrieve" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves a specific alias." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"50c9e585-e7f5-41c4-9016-9014c15454bc\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"aliasable_id\": null,\n \"aliasable_type\": null,\n \"local_part\": \"first\",\n \"extension\": null,\n \"domain\": \"johndoe.anonaddy.com\",\n \"email\": \"first@johndoe.anonaddy.com\",\n \"active\": true,\n \"description\": null,\n \"from_name\": null,\n \"attached_recipients_only\": false,\n \"emails_forwarded\": 5,\n \"emails_blocked\": 0,\n \"emails_replied\": 0,\n \"emails_sent\": 0,\n \"recipients\": [],\n \"last_forwarded\": \"2019-10-01 09:00:00\",\n \"last_blocked\" : null,\n \"last_replied\" : null,\n \"last_sent\" : null,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\",\n \"deleted_at\": null\n }\n}", "name": "" } ] }, { "name": "Create New Alias", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/aliases", "query": [], "raw": "{{baseUrl}}\/api\/v1\/aliases" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"domain\":\"anonaddy.me\",\"description\":\"For example.com\",\"format\":\"uuid\",\"local_part\":\"hello\",\"recipient_ids\":[\"46eebc50-f7f8-46d7-beb9-c37f04c29a84\"]}" }, "description": "This endpoint creates a new alias." }, "response": [ { "header": [], "code": 201, "body": "{\n \"data\": {\n \"id\": \"50c9e585-e7f5-41c4-9016-9014c15454bc\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"aliasable_id\": null,\n \"aliasable_type\": null,\n \"local_part\": \"50c9e585-e7f5-41c4-9016-9014c15454bc\",\n \"extension\": null,\n \"domain\": \"anonaddy.me\",\n \"email\": \"50c9e585-e7f5-41c4-9016-9014c15454bc@anonaddy.me\",\n \"active\": true,\n \"description\": \"For example.com\",\n \"from_name\": null,\n \"attached_recipients_only\": false,\n \"emails_forwarded\": 5,\n \"emails_blocked\": 0,\n \"emails_replied\": 0,\n \"emails_sent\": 0,\n \"recipients\": [],\n \"last_forwarded\": \"2019-10-01 09:00:00\",\n \"last_blocked\" : null,\n \"last_replied\" : null,\n \"last_sent\" : null,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\",\n \"deleted_at\": null\n }\n}", "name": "" } ] }, { "name": "Update a Specific Alias", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/aliases\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/aliases\/:id", "variable": [ { "id": "id", "key": "id", "value": "50c9e585-e7f5-41c4-9016-9014c15454bc", "description": "The id of the alias to update" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"description\":\"New description\",\"from_name\":\"John Doe\"}" }, "description": "This endpoint updates a specific alias." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"50c9e585-e7f5-41c4-9016-9014c15454bc\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"aliasable_id\": null,\n \"aliasable_type\": null,\n \"local_part\": \"first\",\n \"extension\": null,\n \"domain\": \"johndoe.anonaddy.com\",\n \"email\": \"first@johndoe.anonaddy.com\",\n \"active\": true,\n \"description\": \"New description\",\n \"from_name\": \"John Doe\",\n \"attached_recipients_only\": false,\n \"emails_forwarded\": 5,\n \"emails_blocked\": 0,\n \"emails_replied\": 0,\n \"emails_sent\": 0,\n \"recipients\": [],\n \"last_forwarded\": \"2019-10-01 09:00:00\",\n \"last_blocked\" : null,\n \"last_replied\" : null,\n \"last_sent\" : null,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\",\n \"deleted_at\": null\n }\n}", "name": "" } ] }, { "name": "Restore a Specific Deleted Alias", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/aliases\/:id\/restore", "query": [], "raw": "{{baseUrl}}\/api\/v1\/aliases\/:id\/restore", "variable": [ { "id": "id", "key": "id", "value": "50c9e585-e7f5-41c4-9016-9014c15454bc", "description": "The id of the alias to restore" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint restores a specific deleted alias." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"50c9e585-e7f5-41c4-9016-9014c15454bc\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"aliasable_id\": null,\n \"aliasable_type\": null,\n \"local_part\": \"first\",\n \"extension\": null,\n \"domain\": \"johndoe.anonaddy.com\",\n \"email\": \"first@johndoe.anonaddy.com\",\n \"active\": true,\n \"description\": \"New description\",\n \"from_name\": null,\n \"attached_recipients_only\": false,\n \"emails_forwarded\": 5,\n \"emails_blocked\": 0,\n \"emails_replied\": 0,\n \"emails_sent\": 0,\n \"recipients\": [],\n \"last_forwarded\": \"2019-10-01 09:00:00\",\n \"last_blocked\" : null,\n \"last_replied\" : null,\n \"last_sent\" : null,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\",\n \"deleted_at\": null\n }\n}", "name": "" } ] }, { "name": "Delete a Specific Alias", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/aliases\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/aliases\/:id", "variable": [ { "id": "id", "key": "id", "value": "50c9e585-e7f5-41c4-9016-9014c15454bc", "description": "The id of the alias to delete" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint deletes a specific alias." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Destroy a Specific Alias", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/aliases\/:id\/destroy", "query": [], "raw": "{{baseUrl}}\/api\/v1\/aliases\/:id\/destroy", "variable": [ { "id": "id", "key": "id", "value": "50c9e585-e7f5-41c4-9016-9014c15454bc", "description": "The id of the alias to destroy" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint destroys a specific alias." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Activate a Specific Alias", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/active-aliases", "query": [], "raw": "{{baseUrl}}\/api\/v1\/active-aliases" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"50c9e585-e7f5-41c4-9016-9014c15454bc\"}" }, "description": "This endpoint activates a specific alias." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"50c9e585-e7f5-41c4-9016-9014c15454bc\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"aliasable_id\": null,\n \"aliasable_type\": null,\n \"local_part\": \"50c9e585-e7f5-41c4-9016-9014c15454bc\",\n \"extension\": null,\n \"domain\": \"anonaddy.me\",\n \"email\": \"50c9e585-e7f5-41c4-9016-9014c15454bc@anonaddy.me\",\n \"active\": true,\n \"description\": null,\n \"from_name\": null,\n \"attached_recipients_only\": false,\n \"emails_forwarded\": 5,\n \"emails_blocked\": 0,\n \"emails_replied\": 0,\n \"emails_sent\": 0,\n \"recipients\": [],\n \"last_forwarded\": \"2019-10-01 09:00:00\",\n \"last_blocked\" : null,\n \"last_replied\" : null,\n \"last_sent\" : null,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\",\n \"deleted_at\": null\n }\n}", "name": "" } ] }, { "name": "Deactivate a Specific Alias", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/active-aliases\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/active-aliases\/:id", "variable": [ { "id": "id", "key": "id", "value": "50c9e585-e7f5-41c4-9016-9014c15454bc", "description": "The id of the alias to deactivate" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint deactivates a specific alias." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Limit the recipients that can reply\/send from this alias", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/attached-recipients-only", "query": [], "raw": "{{baseUrl}}\/api\/v1\/attached-recipients-only" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"50c9e585-e7f5-41c4-9016-9014c15454bc\"}" }, "description": "This endpoint limits the recipients that can reply\/send from this alias to only those directly attached to it." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"50c9e585-e7f5-41c4-9016-9014c15454bc\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"aliasable_id\": null,\n \"aliasable_type\": null,\n \"local_part\": \"50c9e585-e7f5-41c4-9016-9014c15454bc\",\n \"extension\": null,\n \"domain\": \"anonaddy.me\",\n \"email\": \"50c9e585-e7f5-41c4-9016-9014c15454bc@anonaddy.me\",\n \"active\": true,\n \"description\": null,\n \"from_name\": null,\n \"attached_recipients_only\": true,\n \"emails_forwarded\": 5,\n \"emails_blocked\": 0,\n \"emails_replied\": 0,\n \"emails_sent\": 0,\n \"recipients\": [],\n \"last_forwarded\": \"2019-10-01 09:00:00\",\n \"last_blocked\" : null,\n \"last_replied\" : null,\n \"last_sent\" : null,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\",\n \"deleted_at\": null\n }\n}", "name": "" } ] }, { "name": "Disable the limit of recipients that can reply\/send from this alias", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/attached-recipients-only\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/attached-recipients-only\/:id", "variable": [ { "id": "id", "key": "id", "value": "50c9e585-e7f5-41c4-9016-9014c15454bc", "description": "The id of the alias to disable the limit for for" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint disables the limit of recipients that can reply\/send from this alias." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Update Recipients for a Specific Alias", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/alias-recipients", "query": [], "raw": "{{baseUrl}}\/api\/v1\/alias-recipients" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"alias_id\":\"50c9e585-e7f5-41c4-9016-9014c15454bc\",\"recipient_ids\":[\"46eebc50-f7f8-46d7-beb9-c37f04c29a84\"]}" }, "description": "This endpoint updates the recipients for a specific alias." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"50c9e585-e7f5-41c4-9016-9014c15454bc\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"aliasable_id\": null,\n \"aliasable_type\": null,\n \"local_part\": \"first\",\n \"extension\": null,\n \"domain\": \"johndoe.anonaddy.com\",\n \"email\": \"first@johndoe.anonaddy.com\",\n \"active\": true,\n \"description\": null,\n \"from_name\": null,\n \"attached_recipients_only\": false,\n \"emails_forwarded\": 5,\n \"emails_blocked\": 0,\n \"emails_replied\": 0,\n \"emails_sent\": 0,\n \"recipients\": [\n {\n \"id\": \"46eebc50-f7f8-46d7-beb9-c37f04c29a84\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"email\": \"me@example.com\",\n \"can_reply_send\": true,\n \"should_encrypt\": false,\n \"inline_encryption\": false,\n \"protected_headers\": false,\n \"fingerprint\": null,\n \"email_verified_at\": \"2019-10-01 09:00:00\",\n \"aliases\": [],\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n ],\n \"last_forwarded\": \"2019-10-01 09:00:00\",\n \"last_blocked\" : null,\n \"last_replied\" : null,\n \"last_sent\" : null,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\",\n \"deleted_at\": null\n }\n}", "name": "" } ] } ] }, { "name": "App Version", "description": "", "item": [ { "name": "Get The Current addy.io App Version", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/app-version", "query": [], "raw": "{{baseUrl}}\/api\/v1\/app-version" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves details about the current addy.io version (only available for self-hosted instances)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"version\": \"0.1.4\",\n \"major\": 0,\n \"minor\": 1,\n \"patch\": 4\n}", "name": "" } ] } ] }, { "name": "Domain Options", "description": "", "item": [ { "name": "Get All Domain Options", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/domain-options", "query": [], "raw": "{{baseUrl}}\/api\/v1\/domain-options" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves all domain options." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n \"anonaddy.me\",\n \"johndoe.anonaddy.com\",\n \"johndoe.anonaddy.me\"\n ],\n \"sharedDomains\": [\"anonaddy.me\"],\n \"defaultAliasDomain\": \"anonaddy.me\",\n \"defaultAliasFormat\": \"random_words\"\n}", "name": "" } ] } ] }, { "name": "Domains", "description": "", "item": [ { "name": "Get All Domains", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/domains", "query": [], "raw": "{{baseUrl}}\/api\/v1\/domains" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves all domains." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"0ad7a75a-1517-4b86-bb8a-9443d4965e60\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"domain\": \"example.com\",\n \"description\": null,\n \"from_name\": null,\n \"aliases_count\": 5,\n \"default_recipient\": null,\n \"active\": true,\n \"catch_all\": true,\n \"auto_create_regex\": null,\n \"domain_verified_at\": \"2019-10-01 09:00:00\",\n \"domain_mx_validated_at\": \"2019-10-01 09:00:00\",\n \"domain_sending_verified_at\": \"2019-10-01 09:00:00\",\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n },\n {\n \"id\": \"9a7308d9-fcde-4510-b853-6b09e87b42af\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"domain\": \"example.me\",\n \"description\": null,\n \"from_name\": null,\n \"aliases_count\": 1,\n \"default_recipient\": null,\n \"active\": true,\n \"catch_all\": true,\n \"auto_create_regex\": null,\n \"domain_verified_at\": null,\n \"domain_mx_validated_at\": null,\n \"domain_sending_verified_at\": null,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n ]\n}", "name": "" } ] }, { "name": "Get a Specific Domain", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/domains\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/domains\/:id", "variable": [ { "id": "id", "key": "id", "value": "0ad7a75a-1517-4b86-bb8a-9443d4965e60", "description": "The id of the domain to retrieve" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves a specific domain." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"0ad7a75a-1517-4b86-bb8a-9443d4965e60\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"domain\": \"example.com\",\n \"description\": null,\n \"from_name\": null,\n \"aliases_count\": 5,\n \"default_recipient\": null,\n \"active\": true,\n \"catch_all\": true,\n \"auto_create_regex\": null,\n \"domain_verified_at\": \"2019-10-01 09:00:00\",\n \"domain_mx_validated_at\": \"2019-10-01 09:00:00\",\n \"domain_sending_verified_at\": \"2019-10-01 09:00:00\",\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n}", "name": "" } ] }, { "name": "Create New Domain", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/domains", "query": [], "raw": "{{baseUrl}}\/api\/v1\/domains" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"domain\":\"example.com\"}" }, "description": "This endpoint creates a new domain." }, "response": [ { "header": [], "code": 201, "body": "{\n \"data\": {\n \"id\": \"0ad7a75a-1517-4b86-bb8a-9443d4965e60\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"domain\": \"example.com\",\n \"description\": null,\n \"from_name\": null,\n \"aliases_count\": 5,\n \"default_recipient\": null,\n \"active\": true,\n \"catch_all\": true,\n \"auto_create_regex\": null,\n \"domain_verified_at\": \"2019-10-01 09:00:00\",\n \"domain_mx_validated_at\": \"2019-10-01 09:00:00\",\n \"domain_sending_verified_at\": \"2019-10-01 09:00:00\",\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n}", "name": "" } ] }, { "name": "Update a Specific Domain", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/domains\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/domains\/:id", "variable": [ { "id": "id", "key": "id", "value": "0ad7a75a-1517-4b86-bb8a-9443d4965e60", "description": "The id of the domain to update" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"description\":\"New description\",\"from_name\":\"Mr Example\",\"auto_create_regex\":\"^prefix\"}" }, "description": "This endpoint updates a specific domain." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"0ad7a75a-1517-4b86-bb8a-9443d4965e60\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"domain\": \"example.com\",\n \"description\": \"New description\",\n \"from_name\": \"Mr Example\",\n \"aliases_count\": 5,\n \"default_recipient\": null,\n \"active\": true,\n \"catch_all\": true,\n \"auto_create_regex\": \"^prefix\",\n \"domain_verified_at\": \"2019-10-01 09:00:00\",\n \"domain_mx_validated_at\": \"2019-10-01 09:00:00\",\n \"domain_sending_verified_at\": \"2019-10-01 09:00:00\",\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n}", "name": "" } ] }, { "name": "Delete a Specific Domain", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/domains\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/domains\/:id", "variable": [ { "id": "id", "key": "id", "value": "0ad7a75a-1517-4b86-bb8a-9443d4965e60", "description": "The id of the domain to delete" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint deletes a specific domain." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Update Default Recipient for a Specific Domain", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/domains\/:id\/default-recipient", "query": [], "raw": "{{baseUrl}}\/api\/v1\/domains\/:id\/default-recipient", "variable": [ { "id": "id", "key": "id", "value": "0ad7a75a-1517-4b86-bb8a-9443d4965e60", "description": "The id of the domain to update" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"default_recipient\":\"46eebc50-f7f8-46d7-beb9-c37f04c29a84\"}" }, "description": "This endpoint updates the default recipient for a specific domain." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"0ad7a75a-1517-4b86-bb8a-9443d4965e60\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"domain\": \"example.com\",\n \"description\": null,\n \"from_name\": null,\n \"aliases_count\": 5,\n \"default_recipient\": {\n \"id\": \"46eebc50-f7f8-46d7-beb9-c37f04c29a84\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"email\": \"me@example.com\",\n \"can_reply_send\": true,\n \"should_encrypt\": false,\n \"inline_encryption\": false,\n \"protected_headers\": false,\n \"fingerprint\": null,\n \"email_verified_at\": \"2019-10-01 09:00:00\",\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n },\n \"active\": true,\n \"catch_all\": true,\n \"auto_create_regex\": null,\n \"domain_verified_at\": \"2019-10-01 09:00:00\",\n \"domain_mx_validated_at\": \"2019-10-01 09:00:00\",\n \"domain_sending_verified_at\": \"2019-10-01 09:00:00\",\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n}", "name": "" } ] }, { "name": "Activate a Specific Domain", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/active-domains", "query": [], "raw": "{{baseUrl}}\/api\/v1\/active-domains" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"0ad7a75a-1517-4b86-bb8a-9443d4965e60\"}" }, "description": "This endpoint activates a specific domain." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"0ad7a75a-1517-4b86-bb8a-9443d4965e60\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"domain\": \"example.com\",\n \"description\": null,\n \"from_name\": null,\n \"aliases_count\": 5,\n \"default_recipient\": null,\n \"active\": true,\n \"catch_all\": true,\n \"auto_create_regex\": null,\n \"domain_verified_at\": \"2019-10-01 09:00:00\",\n \"domain_mx_validated_at\": \"2019-10-01 09:00:00\",\n \"domain_sending_verified_at\": \"2019-10-01 09:00:00\",\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n}", "name": "" } ] }, { "name": "Deactivate a Specific Domain", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/active-domains\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/active-domains\/:id", "variable": [ { "id": "id", "key": "id", "value": "0ad7a75a-1517-4b86-bb8a-9443d4965e60", "description": "The id of the domain to deactivate" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint deactivates a specific domain." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Enable catch-all for a Specific Domain", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/catch-all-domains", "query": [], "raw": "{{baseUrl}}\/api\/v1\/catch-all-domains" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"0ad7a75a-1517-4b86-bb8a-9443d4965e60\"}" }, "description": "This endpoint enables catch-all a specific domain." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"0ad7a75a-1517-4b86-bb8a-9443d4965e60\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"domain\": \"example.com\",\n \"from_name\": null,\n \"description\": null,\n \"aliases_count\": 5,\n \"default_recipient\": null,\n \"active\": true,\n \"catch_all\": true,\n \"auto_create_regex\": null,\n \"domain_verified_at\": \"2019-10-01 09:00:00\",\n \"domain_mx_validated_at\": \"2019-10-01 09:00:00\",\n \"domain_sending_verified_at\": \"2019-10-01 09:00:00\",\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n}", "name": "" } ] }, { "name": "Disable catch-all for a Specific Domain", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/catch-all-domains\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/catch-all-domains\/:id", "variable": [ { "id": "id", "key": "id", "value": "0ad7a75a-1517-4b86-bb8a-9443d4965e60", "description": "The id of the domain to disable catch-all" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint disables catch-all for a specific domain." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] } ] }, { "name": "Failed Deliveries", "description": "", "item": [ { "name": "Get All Failed Deliveries", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/failed-deliveries", "query": [], "raw": "{{baseUrl}}\/api\/v1\/failed-deliveries" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves all failed deliveries." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"0222b9fe-59d0-4066-a711-c44ad42f1734\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"recipient_id\": \"46eebc50-f7f8-46d7-beb9-c37f04c29a84\",\n \"recipient_email\": \"user@recipient.com\",\n \"alias_id\": \"50c9e585-e7f5-41c4-9016-9014c15454bc\",\n \"alias_email\": \"alias@anonaddy.com\",\n \"bounce_type\": \"spam\",\n \"remote_mta\": \"mail.icloud.com\",\n \"sender\": \"sender@example.com\",\n \"email_type\": \"F\",\n \"status\": \"5.7.1\",\n \"code\": \"smtp; 554 5.7.1 [CS01] Message rejected due to local policy. Please visit https:\/\/support.apple.com\/en-us\/HT204137\",\n \"is_stored\": true,\n \"attempted_at\": \"2019-10-01 09:00:00\",\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n },\n {\n \"id\": \"f6d1cfe6-46b6-4068-5881-b7cd07dac8a2\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"recipient_id\": \"46eebc50-f7f8-46d7-beb9-c37f04c29a84\",\n \"recipient_email\": \"user@recipient.com\",\n \"alias_id\": \"50c9e585-e7f5-41c4-9016-9014c15454bc\",\n \"alias_email\": \"alias@anonaddy.com\",\n \"bounce_type\": \"hard\",\n \"remote_mta\": \"mail.example.com\",\n \"sender\": \"sender@example.com\",\n \"email_type\": \"F\",\n \"status\": \"5.7.1\",\n \"code\": \"smtp; 550 5.7.1 : Recipient address rejected: Recipient not found\",\n \"is_stored\": false,\n \"attempted_at\": \"2019-10-01 09:00:00\",\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n ]\n}", "name": "" } ] }, { "name": "Get a Specific Failed Delivery", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/failed-deliveries\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/failed-deliveries\/:id", "variable": [ { "id": "id", "key": "id", "value": "46eebc50-f7f8-46d7-beb9-c37f04c29a84", "description": "The id of the failed delivery to retrieve" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves a specific failed delivery." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"0222b9fe-59d0-4066-a711-c44ad42f1734\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"recipient_id\": \"46eebc50-f7f8-46d7-beb9-c37f04c29a84\",\n \"recipient_email\": \"user@recipient.com\",\n \"alias_id\": \"50c9e585-e7f5-41c4-9016-9014c15454bc\",\n \"alias_email\": \"alias@anonaddy.com\",\n \"bounce_type\": \"spam\",\n \"remote_mta\": \"mail.icloud.com\",\n \"sender\": \"sender@example.com\",\n \"email_type\": \"F\",\n \"status\": \"5.7.1\",\n \"code\": \"smtp; 554 5.7.1 [CS01] Message rejected due to local policy. Please visit https:\/\/support.apple.com\/en-us\/HT204137\",\n \"is_stored\": true,\n \"attempted_at\": \"2019-10-01 09:00:00\",\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n}", "name": "" } ] }, { "name": "Delete a Specific Failed Delivery", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/failed-deliveries\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/failed-deliveries\/:id", "variable": [ { "id": "id", "key": "id", "value": "46eebc50-f7f8-46d7-beb9-c37f04c29a84", "description": "The id of the failed delivery to delete" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint deletes a specific failed delivery." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Download a Specific Failed Delivery", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/failed-deliveries\/:id\/download", "query": [], "raw": "{{baseUrl}}\/api\/v1\/failed-deliveries\/:id\/download", "variable": [ { "id": "id", "key": "id", "value": "46eebc50-f7f8-46d7-beb9-c37f04c29a84", "description": "The id of the failed delivery to retrieve" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint downloads a specific failed delivery." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Resend a Specific Failed Delivery", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/failed-deliveries\/:id\/resend", "query": [], "raw": "{{baseUrl}}\/api\/v1\/failed-deliveries\/:id\/resend", "variable": [ { "id": "id", "key": "id", "value": "46eebc50-f7f8-46d7-beb9-c37f04c29a84", "description": "The id of the failed delivery to resend" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"recipient_ids\":[\"46eebc50-f7f8-46d7-beb9-c37f04c29a84\"]}" }, "description": "This endpoint resends a specific failed delivery." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] } ] }, { "name": "Recipients", "description": "", "item": [ { "name": "Get All Recipients", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/recipients", "query": [ { "key": "filter%5Bverified%5D", "value": "true", "description": "Choose to return recipients that are verified or unverified. Options: true, false.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/recipients?filter%5Bverified%5D=true" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves all recipients." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"46eebc50-f7f8-46d7-beb9-c37f04c29a84\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"email\": \"me@example.com\",\n \"can_reply_send\": true,\n \"should_encrypt\": false,\n \"inline_encryption\": false,\n \"protected_headers\": false,\n \"fingerprint\": null,\n \"email_verified_at\": \"2019-10-01 09:00:00\",\n \"aliases_count\": 5,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n },\n {\n \"id\": \"8f515035-efed-4daa-b708-9692a155fa14\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"email\": \"hello@example.com\",\n \"can_reply_send\": true,\n \"should_encrypt\": false,\n \"inline_encryption\": false,\n \"protected_headers\": false,\n \"fingerprint\": null,\n \"email_verified_at\": \"2019-10-01 09:00:00\",\n \"aliases_count\": 0,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n ]\n}", "name": "" } ] }, { "name": "Get a Specific Recipient", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/recipients\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/recipients\/:id", "variable": [ { "id": "id", "key": "id", "value": "46eebc50-f7f8-46d7-beb9-c37f04c29a84", "description": "The id of the recipient to retrieve" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves a specific recipient." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"46eebc50-f7f8-46d7-beb9-c37f04c29a84\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"email\": \"me@example.com\",\n \"can_reply_send\": true,\n \"should_encrypt\": false,\n \"inline_encryption\": false,\n \"protected_headers\": false,\n \"fingerprint\": null,\n \"email_verified_at\": null,\n \"aliases_count\": 5,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n}", "name": "" } ] }, { "name": "Create New Recipient", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/recipients", "query": [], "raw": "{{baseUrl}}\/api\/v1\/recipients" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"me@example.com\"}" }, "description": "This endpoint creates a new recipient." }, "response": [ { "header": [], "code": 201, "body": "{\n \"data\": {\n \"id\": \"46eebc50-f7f8-46d7-beb9-c37f04c29a84\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"email\": \"me@example.com\",\n \"can_reply_send\": true,\n \"should_encrypt\": false,\n \"inline_encryption\": false,\n \"protected_headers\": false,\n \"fingerprint\": null,\n \"email_verified_at\": null,\n \"aliases_count\": 0,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n}", "name": "" } ] }, { "name": "Delete a Specific Recipient", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/recipients\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/recipients\/:id", "variable": [ { "id": "id", "key": "id", "value": "46eebc50-f7f8-46d7-beb9-c37f04c29a84", "description": "The id of the recipient to delete" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint deletes a specific recipient." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Resend the verification email for a recipient", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/recipients\/email\/resend", "query": [], "raw": "{{baseUrl}}\/api\/v1\/recipients\/email\/resend" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"recipient_id\":\"46eebc50-f7f8-46d7-beb9-c37f04c29a84\"}" }, "description": "This endpoint can be used to resend the verification email when adding a new recipient" }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "" } ] }, { "name": "Add Public Key for a Specific Recipient", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/recipient-keys\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/recipient-keys\/:id", "variable": [ { "id": "id", "key": "id", "value": "46eebc50-f7f8-46d7-beb9-c37f04c29a84", "description": "The id of the recipient to add the key for" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"key_data\":\"-----BEGIN PGP PUBLIC KEY BLOCK-----\"}" }, "description": "This endpoint adds a public GPG\/OpenPGP key for a specific recipient. Make sure to escape the json using something like - https:\/\/jsonformatter.org\/json-escape" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"46eebc50-f7f8-46d7-beb9-c37f04c29a84\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"email\": \"me@example.com\",\n \"can_reply_send\": true,\n \"should_encrypt\": true,\n \"inline_encryption\": false,\n \"protected_headers\": false,\n \"fingerprint\": \"70E400B5064061EB84181DABEDADE14D67325B36\",\n \"email_verified_at\": \"2019-10-01 09:00:00\",\n \"aliases_count\": 5,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n}", "name": "" } ] }, { "name": "Remove Public Key for a Specific Recipient", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/recipient-keys\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/recipient-keys\/:id", "variable": [ { "id": "id", "key": "id", "value": "46eebc50-f7f8-46d7-beb9-c37f04c29a84", "description": "The id of the recipient to remove the key for" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint remnoves a public GPG\/OpenPGP key for a specific recipient." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Enable Encryption for a Specific Recipient", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/encrypted-recipients", "query": [], "raw": "{{baseUrl}}\/api\/v1\/encrypted-recipients" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"46eebc50-f7f8-46d7-beb9-c37f04c29a84\"}" }, "description": "This endpoint enables encryption for a specific recipient." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"46eebc50-f7f8-46d7-beb9-c37f04c29a84\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"email\": \"me@example.com\",\n \"can_reply_send\": true,\n \"should_encrypt\": true,\n \"inline_encryption\": false,\n \"protected_headers\": false,\n \"fingerprint\": \"70E400B5064061EB84181DABEDADE14D67325B36\",\n \"email_verified_at\": \"2019-10-01 09:00:00\",\n \"aliases_count\": 5,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n}", "name": "" } ] }, { "name": "Disable Encryption for a Specific Recipient", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/encrypted-recipients\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/encrypted-recipients\/:id", "variable": [ { "id": "id", "key": "id", "value": "46eebc50-f7f8-46d7-beb9-c37f04c29a84", "description": "The id of the recipient to disable encryption for" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint disables encryption for a specific recipient." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Enable Inline (PGP\/Inline) Encryption for a Specific Recipient", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/inline-encrypted-recipients", "query": [], "raw": "{{baseUrl}}\/api\/v1\/inline-encrypted-recipients" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"46eebc50-f7f8-46d7-beb9-c37f04c29a84\"}" }, "description": "This endpoint enables inline encryption for a specific recipient." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"46eebc50-f7f8-46d7-beb9-c37f04c29a84\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"email\": \"me@example.com\",\n \"can_reply_send\": true,\n \"should_encrypt\": true,\n \"inline_encryption\": true,\n \"protected_headers\": false,\n \"fingerprint\": \"70E400B5064061EB84181DABEDADE14D67325B36\",\n \"email_verified_at\": \"2019-10-01 09:00:00\",\n \"aliases_count\": 5,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n}", "name": "" } ] }, { "name": "Disable Inline (PGP\/Inline) Encryption for a Specific Recipient", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/inline-encrypted-recipients\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/inline-encrypted-recipients\/:id", "variable": [ { "id": "id", "key": "id", "value": "46eebc50-f7f8-46d7-beb9-c37f04c29a84", "description": "The id of the recipient to disable inline encryption for" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint disables inline encryption for a specific recipient." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Enable Protected Headers (hide subject) for a Specific Recipient", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/protected-headers-recipients", "query": [], "raw": "{{baseUrl}}\/api\/v1\/protected-headers-recipients" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"46eebc50-f7f8-46d7-beb9-c37f04c29a84\"}" }, "description": "This endpoint enables protected headers which hides the message subject for a specific recipient." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"46eebc50-f7f8-46d7-beb9-c37f04c29a84\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"email\": \"me@example.com\",\n \"can_reply_send\": true,\n \"should_encrypt\": true,\n \"inline_encryption\": false,\n \"protected_headers\": true,\n \"fingerprint\": \"70E400B5064061EB84181DABEDADE14D67325B36\",\n \"email_verified_at\": \"2019-10-01 09:00:00\",\n \"aliases_count\": 5,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n}", "name": "" } ] }, { "name": "Disable Protected Headers (hide subject) for a Specific Recipient", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/protected-headers-recipients\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/protected-headers-recipients\/:id", "variable": [ { "id": "id", "key": "id", "value": "46eebc50-f7f8-46d7-beb9-c37f04c29a84", "description": "The id of the recipient to disable protected headers for" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint disables protected headers for a specific recipient." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Allow a Specific Recipient to reply\/send from your aliases", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/allowed-recipients", "query": [], "raw": "{{baseUrl}}\/api\/v1\/allowed-recipients" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"46eebc50-f7f8-46d7-beb9-c37f04c29a84\"}" }, "description": "This endpoint allows a specific recipient to reply\/send." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"46eebc50-f7f8-46d7-beb9-c37f04c29a84\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"email\": \"me@example.com\",\n \"can_reply_send\": true,\n \"should_encrypt\": true,\n \"inline_encryption\": false,\n \"protected_headers\": false,\n \"fingerprint\": \"70E400B5064061EB84181DABEDADE14D67325B36\",\n \"email_verified_at\": \"2019-10-01 09:00:00\",\n \"aliases_count\": 5,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n}", "name": "" } ] }, { "name": "Disallow a Specific Recipient to reply\/send from your aliases", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/allowed-recipients\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/allowed-recipients\/:id", "variable": [ { "id": "id", "key": "id", "value": "46eebc50-f7f8-46d7-beb9-c37f04c29a84", "description": "The id of the recipient to disallow replies\/sends for" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint disallows a specific recipient to reply\/send." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] } ] }, { "name": "Rules", "description": "", "item": [ { "name": "Get All Rules", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rules", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rules" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves all rules." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"50c9e585-e7f5-41c4-9016-9014c15454bc\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"name\": \"First Rule\",\n \"order\": 0,\n \"conditions\": [\n {\n \"type\": \"sender\",\n \"match\": \"is not\",\n \"values\": [\n \"will@anonaddy.com\"\n ]\n }\n ],\n \"actions\": [\n {\n \"type\": \"subject\",\n \"value\": \"New Subject\"\n }\n ],\n \"operator\": \"AND\",\n \"forwards\": true,\n \"replies\": false,\n \"sends\": false,\n \"active\": true,\n \"applied\": 5,\n \"last_applied\": \"2019-10-01 09:00:00\",\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n },\n {\n \"id\": \"c549db7d-5fac-4b09-9443-9e47f644d29f\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"name\": \"Second Rule\",\n \"order\": 0,\n \"conditions\": [\n {\n \"type\": \"sender\",\n \"match\": \"is exactly\",\n \"values\": [\n \"will@anonaddy.com\"\n ]\n }\n ],\n \"actions\": [\n {\n \"type\": \"subject\",\n \"value\": \"Another Subject\"\n }\n ],\n \"operator\": \"OR\",\n \"forwards\": true,\n \"replies\": false,\n \"sends\": false,\n \"active\": true,\n \"applied\": 3,\n \"last_applied\": \"2019-10-01 09:00:00\",\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n ]\n}", "name": "" } ] }, { "name": "Get a Specific Rule", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rules\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rules\/:id", "variable": [ { "id": "id", "key": "id", "value": "50c9e585-e7f5-41c4-9016-9014c15454bc", "description": "The id of the rule to retrieve" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves a specific rule." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\":{\n \"id\": \"50c9e585-e7f5-41c4-9016-9014c15454bc\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"name\": \"First Rule\",\n \"order\": 0,\n \"conditions\": [\n {\n \"type\": \"sender\",\n \"match\": \"is exactly\",\n \"values\": [\n \"will@anonaddy.com\"\n ]\n }\n ],\n \"actions\": [\n {\n \"type\": \"subject\",\n \"value\": \"New Subject!\"\n }\n ],\n \"operator\": \"AND\",\n \"forwards\": true,\n \"replies\": false,\n \"sends\": false,\n \"active\": true,\n \"applied\": 5,\n \"last_applied\": \"2019-10-01 09:00:00\",\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n}", "name": "" } ] }, { "name": "Create New Rule", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rules", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rules" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"First Rule\",\"conditions\":[{\"type\":\"sender\",\"match\":\"is exactly\",\"values\":[\"will@anonaddy.com\"]}],\"actions\":[{\"type\":\"subject\",\"value\":\"New Subject!\"}],\"operator\":\"AND\",\"forwards\":true,\"replies\":false,\"sends\":false}" }, "description": "This endpoint creates a new rule." }, "response": [ { "header": [], "code": 201, "body": "{\n \"data\":{\n \"id\": \"50c9e585-e7f5-41c4-9016-9014c15454bc\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"name\": \"First Rule\",\n \"order\": 0,\n \"conditions\": [\n {\n \"type\": \"sender\",\n \"match\": \"is exactly\",\n \"values\": [\n \"will@anonaddy.com\"\n ]\n }\n ],\n \"actions\": [\n {\n \"type\": \"subject\",\n \"value\": \"New Subject!\"\n }\n ],\n \"operator\": \"AND\",\n \"forwards\": true,\n \"replies\": false,\n \"sends\": false,\n \"active\": true,\n \"applied\": 0,\n \"last_applied\": null,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n}", "name": "" } ] }, { "name": "Update a Specific Rule", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rules\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rules\/:id", "variable": [ { "id": "id", "key": "id", "value": "50c9e585-e7f5-41c4-9016-9014c15454bc", "description": "The id of the rule to update" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"New Name\",\"conditions\":[{\"type\":\"sender\",\"match\":\"is exactly\",\"values\":[\"will@anonaddy.com\"]}],\"actions\":[{\"type\":\"subject\",\"value\":\"New Subject!\"}],\"operator\":\"AND\",\"forwards\":true,\"replies\":false,\"sends\":false}" }, "description": "This endpoint updates a specific rule." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\":{\n \"id\": \"50c9e585-e7f5-41c4-9016-9014c15454bc\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"name\": \"New Name\",\n \"order\": 0,\n \"conditions\": [\n {\n \"type\": \"sender\",\n \"match\": \"is exactly\",\n \"values\": [\n \"will@anonaddy.com\"\n ]\n }\n ],\n \"actions\": [\n {\n \"type\": \"subject\",\n \"value\": \"New Subject!\"\n }\n ],\n \"operator\": \"AND\",\n \"forwards\": true,\n \"replies\": false,\n \"sends\": false,\n \"active\": true,\n \"applied\": 5,\n \"last_applied\": \"2019-10-01 09:00:00\",\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n}", "name": "" } ] }, { "name": "Delete a Specific Rule", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rules\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rules\/:id", "variable": [ { "id": "id", "key": "id", "value": "50c9e585-e7f5-41c4-9016-9014c15454bc", "description": "The id of the rule to delete" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint deletes a specific rule." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Update the order of the Rules", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/reorder-rules", "query": [], "raw": "{{baseUrl}}\/api\/v1\/reorder-rules" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ids\":[\"c549db7d-5fac-4b09-9443-9e47f644d29f\",\"50c9e585-e7f5-41c4-9016-9014c15454bc\"]}" }, "description": "This endpoint updates the order of the rules." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "" } ] }, { "name": "Activate a Specific Rule", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/active-rules", "query": [], "raw": "{{baseUrl}}\/api\/v1\/active-rules" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"50c9e585-e7f5-41c4-9016-9014c15454bc\"}" }, "description": "This endpoint activates a specific Rule." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\":{\n \"id\": \"50c9e585-e7f5-41c4-9016-9014c15454bc\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"name\": \"First Rule\",\n \"order\": 0,\n \"conditions\": [\n {\n \"type\": \"sender\",\n \"match\": \"is exactly\",\n \"values\": [\n \"will@anonaddy.com\"\n ]\n }\n ],\n \"actions\": [\n {\n \"type\": \"subject\",\n \"value\": \"New Subject!\"\n }\n ],\n \"operator\": \"AND\",\n \"forwards\": true,\n \"replies\": false,\n \"sends\": false,\n \"active\": true,\n \"applied\": 5,\n \"last_applied\": \"2019-10-01 09:00:00\",\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n}", "name": "" } ] }, { "name": "Deactivate a Specific Rule", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/active-rules\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/active-rules\/:id", "variable": [ { "id": "id", "key": "id", "value": "50c9e585-e7f5-41c4-9016-9014c15454bc", "description": "The id of the rule to deactivate" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint deactivates a specific rule." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] } ] }, { "name": "Usernames", "description": "", "item": [ { "name": "Get All Usernames", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/usernames", "query": [], "raw": "{{baseUrl}}\/api\/v1\/usernames" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves all usernames." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"2777dee6-1721-45c0-8d01-698b6be2335f\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"username\": \"johndoe\",\n \"description\": null,\n \"from_name\": null,\n \"aliases_count\": 5,\n \"default_recipient\": null,\n \"active\": true,\n \"catch_all\": true,\n \"auto_create_regex\": null,\n \"can_login\": true,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n },\n {\n \"id\": \"ede18c01-9de2-40f4-8cce-c1e9f623ef2d\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"username\": \"janedoe\",\n \"description\": null,\n \"from_name\": null,\n \"aliases_count\": 0,\n \"default_recipient\": null,\n \"active\": true,\n \"catch_all\": true,\n \"auto_create_regex\": null,\n \"can_login\": true,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n ]\n}", "name": "" } ] }, { "name": "Get a Specific Username", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/usernames\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/usernames\/:id", "variable": [ { "id": "id", "key": "id", "value": "2777dee6-1721-45c0-8d01-698b6be2335f", "description": "The id of the username to retrieve" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves a specific username." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"2777dee6-1721-45c0-8d01-698b6be2335f\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"username\": \"johndoe\",\n \"description\": null,\n \"from_name\": null,\n \"aliases_count\": 5,\n \"default_recipient\": null,\n \"active\": true,\n \"catch_all\": true,\n \"auto_create_regex\": null,\n \"can_login\": true,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n}", "name": "" } ] }, { "name": "Create New Username", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/usernames", "query": [], "raw": "{{baseUrl}}\/api\/v1\/usernames" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"username\":\"johndoe\"}" }, "description": "This endpoint creates a new username." }, "response": [ { "header": [], "code": 201, "body": "{\n \"data\": {\n \"id\": \"2777dee6-1721-45c0-8d01-698b6be2335f\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"username\": \"johndoe\",\n \"description\": null,\n \"from_name\": null,\n \"aliases_count\": 0,\n \"default_recipient\": null,\n \"active\": true,\n \"catch_all\": true,\n \"auto_create_regex\": \"^prefix\",\n \"can_login\": true,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n}", "name": "" } ] }, { "name": "Update a Specific Username", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/usernames\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/usernames\/:id", "variable": [ { "id": "id", "key": "id", "value": "2777dee6-1721-45c0-8d01-698b6be2335f", "description": "The id of the username to update" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"description\":\"New description\",\"from_name\":\"John\",\"auto_create_regex\":\"^prefix\"}" }, "description": "This endpoint updates a specific username." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"2777dee6-1721-45c0-8d01-698b6be2335f\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"username\": \"johndoe\",\n \"description\": \"New description\",\n \"from_name\": \"John\",\n \"aliases_count\": 5,\n \"default_recipient\": null,\n \"active\": true,\n \"catch_all\": true,\n \"auto_create_regex\": null,\n \"can_login\": true,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n}", "name": "" } ] }, { "name": "Delete a Specific Username", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/usernames\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/usernames\/:id", "variable": [ { "id": "id", "key": "id", "value": "2777dee6-1721-45c0-8d01-698b6be2335f", "description": "The id of the username to delete" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint deletes a specific username." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Update Default Recipient for a Specific Username", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/usernames\/:id\/default-recipient", "query": [], "raw": "{{baseUrl}}\/api\/v1\/usernames\/:id\/default-recipient", "variable": [ { "id": "id", "key": "id", "value": "2777dee6-1721-45c0-8d01-698b6be2335f", "description": "The id of the username to update" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"default_recipient\":\"46eebc50-f7f8-46d7-beb9-c37f04c29a84\"}" }, "description": "This endpoint updates the default recipient for a specific username." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"2777dee6-1721-45c0-8d01-698b6be2335f\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"username\": \"johndoe\",\n \"description\": null,\n \"from_name\": null,\n \"aliases_count\": 5,\n \"default_recipient\": {\n \"id\": \"46eebc50-f7f8-46d7-beb9-c37f04c29a84\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"email\": \"me@example.com\",\n \"can_reply_send\": true,\n \"should_encrypt\": false,\n \"inline_encryption\": false,\n \"protected_headers\": false,\n \"fingerprint\": null,\n \"email_verified_at\": \"2019-10-01 09:00:00\",\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n },\n \"active\": true,\n \"catch_all\": true,\n \"auto_create_regex\": null,\n \"can_login\": true,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n}", "name": "" } ] }, { "name": "Activate a Specific Username", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/active-usernames", "query": [], "raw": "{{baseUrl}}\/api\/v1\/active-usernames" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"2777dee6-1721-45c0-8d01-698b6be2335f\"}" }, "description": "This endpoint activates a specific username." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"2777dee6-1721-45c0-8d01-698b6be2335f\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"username\": \"johndoe\",\n \"description\": null,\n \"from_name\": null,\n \"aliases_count\": 5,\n \"default_recipient\": null,\n \"active\": true,\n \"catch_all\": true,\n \"auto_create_regex\": null,\n \"can_login\": true,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n}", "name": "" } ] }, { "name": "Deactivate a Specific Username", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/active-usernames\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/active-usernames\/:id", "variable": [ { "id": "id", "key": "id", "value": "2777dee6-1721-45c0-8d01-698b6be2335f", "description": "The id of the username to deactivate" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint deactivates a specific username." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Enable catch-all for a Specific Username", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/catch-all-usernames", "query": [], "raw": "{{baseUrl}}\/api\/v1\/catch-all-usernames" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"2777dee6-1721-45c0-8d01-698b6be2335f\"}" }, "description": "This endpoint enables catch-all a specific username." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"2777dee6-1721-45c0-8d01-698b6be2335f\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"username\": \"johndoe\",\n \"description\": null,\n \"from_name\": null,\n \"aliases_count\": 5,\n \"default_recipient\": null,\n \"active\": true,\n \"catch_all\": true,\n \"auto_create_regex\": null,\n \"can_login\": true,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n}", "name": "" } ] }, { "name": "Disable catch-all for a Specific Username", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/catch-all-usernames\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/catch-all-usernames\/:id", "variable": [ { "id": "id", "key": "id", "value": "2777dee6-1721-45c0-8d01-698b6be2335f", "description": "The id of the username to disable catch-all" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint disables catch-all for a specific username." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Allow login for a Specific Username", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/loginable-usernames", "query": [], "raw": "{{baseUrl}}\/api\/v1\/loginable-usernames" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"2777dee6-1721-45c0-8d01-698b6be2335f\"}" }, "description": "This endpoint gives a specific username the ability to login to your account." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"2777dee6-1721-45c0-8d01-698b6be2335f\",\n \"user_id\": \"ca0a4e09-c266-4f6f-845c-958db5090f09\",\n \"username\": \"johndoe\",\n \"description\": null,\n \"from_name\": null,\n \"aliases_count\": 5,\n \"default_recipient\": null,\n \"active\": true,\n \"catch_all\": true,\n \"auto_create_regex\": null,\n \"can_login\": true,\n \"created_at\": \"2019-10-01 09:00:00\",\n \"updated_at\": \"2019-10-01 09:00:00\"\n }\n}", "name": "" } ] }, { "name": "Disallow login for a Specific Username", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/loginable-usernames\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/loginable-usernames\/:id", "variable": [ { "id": "id", "key": "id", "value": "2777dee6-1721-45c0-8d01-698b6be2335f", "description": "The id of the username" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "X-Requested-With", "value": "XMLHttpRequest" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint prevents a specific username from being able to login to your account." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "type": "string" } ] } }