The SocketLabs API allows you to access SocketLabs features programmatically via HTTP calls without having to log into our Control Panel, allowing you to automate common tasks. Please check back frequently, as we are working hard to add more features.
\nEndpoints may be modified or removed while development is ongoing.
\nFor Complex Sender and Simple Sender, regardless of version, an API key must be created on the API Key Management page in your SocketLabs account. Be sure to choose the `SocketLabs Api` API Access option so your API key will have the correct access.
\nIt is important to keep your API key secure because it can be used to modify features for your SocketLabs account.
\nAll calls to the SocketLabs API are authenticated using the API key that you generated. Authenticate your calls to the SocketLabs API using the Authorization header with the Bearer authentication scheme.
Authorization: Bearer YOUR-API-KEY
If your application or system does not support the Bearer authentication scheme, you may also use the Basic scheme. If using the Basic scheme, you may use any string as the username and then your API key as the password. More information about Basic authentication can be found here.
Authorization: Basic YOUR-API-KEY
Every endpoint that returns an array of results includes offset pagination. Pagination is defined by an order (`sortDirection`), a limit (`pageSize`), and an offset (`pageNumber`) from the start.
\nAdd filters to the query string to narrow down the results based on specific criteria. The format for adding filters is filters=field=predicate:value, where field is the name of the field in the dataset on which to apply the filter, predicate is the type of comparison to perform on the field, and value is the value against which the field should be compared.
You can combile multiple filters by separating them with an &
Example: filters=name=start:jo&emailAddress=end:gmail.com
https://api.socketlabs.com/v1/servers/12345/search/?filters=status=eq:active&isActive=eq:true\n\nWhen filtering by date, three date formats (Each a subset of ISO 8601) are supported. The following date formats may be used:
\nyyyy-MM-ddTHH:mm:ssK\nyyyy-MM-ddK\nyyyy-MM-dd\n\nBy default, all dates will be in UTC time. If you need to specify a local time offset, you can do by adding or subracting the local offset (K property) to your timestamp. For more information on how to use time offsets, please see this Wikipedia article.
Data returned by the SocketLabs API is limited to the dates allowed by the Detailed Reporting History date range for your SocketLabs plan. If you attempt to search a date range that is not allowed by your current plan, an error will be returned. To find out what your current limits are, or to upgrade to a plan with more limits, please navigate to your plans page.
\nThe response type will include the data property containing the array of results and the total property containing the total number of results available.
NOTE: All csv file download endpoints include a Content-Range header. This header specifies units, start, end & total. (ex: rows 0-99/187). Additionally these endpoints will respond with a HTTP Status code of 206 (Partial Content) for all requested pages except the final page which will return a status code of 200 (Ok).
\n{\n \"data\": [\n …\n ],\n \"total\": 123\n}\n\nSometimes there will be errors with your API call. This could be due to any number of issues such as incorrect syntax, validation errors, limits being exceeded, or something going wrong on our server. When this happens the HTTP response will contain an error code, with additional information provided in the response body. The body can contain either a single error or a list of errors.
\n{\n \"error\" : [\n {\n \"errorType\": \"InvalidDomainFormat\",\n \"message\": \"Domain name not formatted correctly.\"\n }\n ]\n}\n\nAll requests against the SocketLabs Api are limited to 100 requests within 60 seconds. Requests made in excess to this limit will result in an error. There are some endpoints whos rate limiting differs from the standard, which are shown below:
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting Started: Create an API Key","slug":"getting-started-create-an-api-key"},{"content":"Pagination","slug":"pagination"},{"content":"Filters","slug":"filters"},{"content":"Date Formats","slug":"date-formats"},{"content":"Response","slug":"response"},{"content":"Error Handling","slug":"error-handling"},{"content":"Rate Limiting","slug":"rate-limiting"}],"owner":"26530112","collectionId":"11f08c1a-ed78-4e34-b5af-ee98916d5fa4","publishedId":"2s93XvWQJC","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-04-26T13:24:47.000Z"},"item":[{"name":"Complex Sender","item":[{"name":"Account","item":[{"name":"API Key Management","item":[{"name":"Get all API Keys for the Account","id":"7b84b1c5-b95e-435b-974c-6211c9bbd09b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v2/credentials/api-key?pageSize=5&pageNumber=0&sortField=name&sortDirection=dsc","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","credentials","api-key"],"host":["/"],"query":[{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"name"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[]}},"response":[{"id":"4bf9fc59-3982-44e3-90f1-bddcbc8863b4","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerNumber of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"domain"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[]}},"response":[{"id":"398c6cf9-b6ce-4c8b-8a3d-bfce310acf81","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerNumber of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"domain"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[]}},"response":[{"id":"5ea64134-364c-4bc6-943b-4e980ef07210","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerEach entry will include the validation status for the domain.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","dkim",":domain"],"host":["/"],"query":[{"description":{"content":"(Optional) The selector for the DKIM entry you are querying..
\n","type":"text/plain"},"key":"selector","value":"dkim"}],"variable":[{"type":"any","value":"example.com","key":"domain"}]}},"response":[{"id":"5a5fc231-9f07-42ed-9e6a-d0e7911f8ea6","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerIf the PrivateKey is not provided, we will generate a new public/private key pair for you.\n Otherwise, we will attempt to validate your private key against the public key for your domain.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","dkim"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"ff8e79a6-ff42-4f6f-8a52-73c3c767d030","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer(Optional) The selector for the DKIM entry you are deleting.
\n","type":"text/plain"},"key":"selector","value":"dkim"}],"variable":[{"type":"any","value":"example.com","key":"domain"}]}},"response":[{"id":"9cd94d34-a0ef-4706-97a1-8bd24833b076","name":"No Content","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"BearerNumber of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"domain"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[]}},"response":[{"id":"d881a889-ba05-42bb-ac36-f192097c2bcc","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerNumber of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"eventUrl"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[]}},"response":[{"id":"72df7f98-b17d-4321-ac6b-294efe70a948","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerRather than using an API to request and pull your message data, a webhook is a programmatic way to receive instant notifications pushed directly to your application.
\nNote: The following examples are used for setting up and testing your webhook endpoint. Please use the links in the Getting Started section for more information on the webhook events that we will send.
\n","_postman_id":"2d5c9a32-678a-4ba1-9c52-8bddd90b3195","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}}},{"name":"IP Address Allocation","item":[{"name":"Get all IPs Allocated","id":"0c9671af-6712-4d09-a398-4fa0505bc76c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v2/ip-allocation?pageSize=5&pageNumber=0&sortField=ipAddress&sortDirection=dsc","description":"Returns a list of IP addresses allocated to your account. If no IPs are available, the list is empty.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","ip-allocation"],"host":["/"],"query":[{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"ipAddress"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[]}},"response":[{"id":"59ece80f-9b6e-4561-a1f0-1f4d55abc8fe","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerReturns a list of IP pools created in your account. The default IP pool will always exist.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","ip-pool"],"host":["/"],"query":[{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"name"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[]}},"response":[{"id":"6581f95c-557d-4804-8987-14bd20dcad22","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerReturns details regarding a specific IP pool.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","ip-pool",":ipPoolId"],"host":["/"],"query":[],"variable":[{"type":"any","value":"12345","key":"ipPoolId"}]}},"response":[{"id":"a6dbfcc3-cbdb-4204-b3e3-922f93870bf4","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerCreates a new IP pool with the IPs assigned to it in the body.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","ip-pool"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"7c34d4c9-c24c-4dda-9a77-4d644943018f","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"BearerEdits the name of an IP pool given the IP pool ID.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","ip-pool",":ipPoolId"],"host":["/"],"query":[],"variable":[{"type":"any","value":"12345","key":"ipPoolId"}]}},"response":[{"id":"ed044eff-681c-4685-ad64-e206213b6742","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"BearerReturns a list of subaccounts in your account. If no subaccounts exist, the list is empty.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","ip-pool",":ipPoolId","subaccounts"],"host":["/"],"query":[{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"name"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"type":"any","value":"12345","key":"ipPoolId"}]}},"response":[{"id":"d72a6e0a-0be3-4e3d-a8f6-923f098b8ff5","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerDirectly assigns a subaccount to an IP pool. If a subaccount is not directly assigned to an IP pool, it will use Rule Engine by default.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","ip-pool",":ipPoolId","subaccounts"],"host":["/"],"query":[],"variable":[{"type":"any","value":"12345","key":"ipPoolId"}]}},"response":[{"id":"fd42fef1-24f5-41a4-be2c-e347c3aadbd6","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerRemoves a subaccount from an assigned IP pool. If a subaccount is not assigned to an IP pool, it will be managed by Rule Engine.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","ip-pool",":ipPoolId","subaccounts"],"host":["/"],"query":[],"variable":[{"type":"any","value":"12345","key":"ipPoolId"}]}},"response":[{"id":"d1f0f460-5852-48f6-86e3-a2c47e6ad6d3","name":"No Content","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"BearerNumber of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"suppressionLastUpdate"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[]}},"response":[{"id":"4e04467c-988a-4f2f-bcf0-60d57bbe2895","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerField used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"suppressionLastUpdate"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[]}},"response":[{"id":"dc76eb43-e46b-433a-9c5a-679b11f0e6fa","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerEmail Address to search by
\n","type":"text/plain"},"key":"emailAddress","value":"test@example.com"}],"variable":[]}},"response":[{"id":"d6fe6ab8-5bfc-4825-a487-a2095367b70a","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerMax of 100 email addresses per call.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","suppressions","bulk"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"13d3e41a-368b-483b-a263-eb096ce5f6ac","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"BearerMax of 100 email addresses per call.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","suppressions","bulk-remove"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"e29ad03c-3642-4ac5-b4e9-f187f710fef1","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"BearerEmail Address to search by
\n","type":"text/plain"},"key":"emailAddress","value":"test@example.com"}],"variable":[]}},"response":[{"id":"14a296ae-b013-4b1b-973f-f2f2ec555a61","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearerthe requested date
\n","type":"text/plain"},"key":"requestDate","value":"2022-01-14"}],"variable":[{"type":"any","value":"12345","key":"ipPoolId"}]}},"response":[{"id":"cc1dc9f2-2341-416f-8831-365a16272de7","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerStarting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"}],"variable":[]}},"response":[{"id":"714776b5-efef-4545-bd0c-c2dd702ded83","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerStarting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"},{"description":{"content":"Type of aggregate to retrieve
\n","type":"text/plain"},"key":"type","value":"type"},{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"1"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"type"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[]}},"response":[{"id":"322b116b-49eb-419f-be6f-782e64ace16b","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerAll requests against the Sending Overview Api are limited to 30 requests within 60 seconds. Requests made in excess to this limit will result in an error.
\n","_postman_id":"8329a818-3b42-4ef6-8717-1df4a6400bb7","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}}},{"name":"StreamMonitor","item":[{"name":"Get the IP Pool StreamMonitor Overview","id":"1ed2af8c-7d7d-47dc-99fc-7b257060e666","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v2/ip-pool/streammonitor/overview?startDate=2022-01-01&endDate=2022-01-05","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","ip-pool","streammonitor","overview"],"host":["/"],"query":[{"description":{"content":"Starting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"}],"variable":[]}},"response":[{"id":"e53ab1e0-10f7-47db-a2c0-c4112ba229c4","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerEnding date range to search
\n","type":"text/plain"},"key":"requestDate","value":"2022-01-01"},{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"name"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[]}},"response":[{"id":"a263d5dd-f42f-4e96-8b92-03c22cf86587","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerStarting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"}],"variable":[]}},"response":[{"id":"6b0c58a0-28c8-413b-9488-b4ba873105df","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerEnding date range to search
\n","type":"text/plain"},"key":"requestDate","value":"2022-01-01"},{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"1"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"name"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[]}},"response":[{"id":"e814646e-fe40-4406-b642-491e72a636a0","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerNumber of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"name"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[]}},"response":[{"id":"2c755842-f3dd-40a9-9b76-9195cb7a6c23","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerStarting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"},{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"to"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[]}},"response":[{"id":"9d9d5c86-db87-4b07-86a2-209d041fa32b","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerAdd a staged DKIM domain to your Account. If the PrivateKey is not provided, we will generate a new public/private key pair for you. Otherwise, we will attempt to validate your private key against the public key for your domain.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","dkim","staged",":domain"],"host":["/"],"query":[],"variable":[{"id":"9d0bc32f-0257-45f1-b4fc-950f519e5625","type":"any","value":"","key":"domain"}]}},"response":[{"id":"3198d7f0-3a0e-466b-a6ca-43f6a4f5e432","name":"200:Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"//v2/dkim/staged/:domain","host":["/"],"path":["v2","dkim","staged",":domain"],"variable":[{"key":"domain","value":""}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"serverId\": 12345,\r\n \"domain\": \"example.com\",\r\n \"selector\": \"selector1\",\r\n \"DnsRecord\": \"v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC8P2f6pNn1g3f5kY7z9e...SAMPLE_KEY_DATA.../O9wIDAQAB\",\r\n \"split\": true,\r\n \"escaped\": false,\r\n \"createdOn\": \"2025-08-08T14:36:30.5818961Z\",\r\n \"updatedOn\": \"0001-01-01T00:00:00\"\r\n }\r\n}"},{"id":"989b4880-79ec-4038-8516-44a1c839b062","name":"409:KeyAlreadyExists","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"Selector\":\"dkim\",\r\n \"Split\":true,\r\n \"Escaped\":false\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"//v2/dkim/staged/:domain","host":["/"],"path":["v2","dkim","staged",":domain"],"variable":[{"key":"domain","value":""}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"error\": [\r\n {\r\n \"errorType\": \"KeyAlreadyExists\",\r\n \"message\": \"DKIM key already exists for the requested domain.\"\r\n }\r\n ]\r\n}"},{"id":"a2ce487c-86f1-4aa0-86c9-b38d25cf8953","name":"400:InvalidRequestBody","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"Selector\":\"dkim\",\r\n \"Split\":true,\r\n \"Escaped\":false\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"//v2/dkim/staged/:domain","host":["/"],"path":["v2","dkim","staged",":domain"],"variable":[{"key":"domain","value":""}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"error\": [\r\n {\r\n \"errorType\": \"InvalidRequestBody\",\r\n \"message\": \"The request is invalid, request body may be missing.\"\r\n }\r\n ]\r\n}"}],"_postman_id":"e006b2ff-90f1-4040-8746-fb83d67a7aec"},{"name":"Get Staged Dkim","id":"f6e32030-588b-4926-b1ac-3cb1216612aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"//v2/dkim/staged/:domain","description":"Get the staged DKIM domain on your Account
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","dkim","staged",":domain"],"host":["/"],"query":[],"variable":[{"id":"6798d93a-07a9-4da9-a999-8284d744970b","type":"any","value":"example.com","key":"domain"}]}},"response":[{"id":"eaaf646f-b992-4bcf-99aa-5473d6a731bc","name":"200:Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v2/dkim/staged/:domain","host":["/"],"path":["v2","dkim","staged",":domain"],"variable":[{"key":"domain","value":"example.com"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"serverId\": 12345,\r\n \"domain\": \"example.com\",\r\n \"selector\": \"selector1\",\r\n \"DnsRecord\": \"v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC8P2f6pNn1g3f5kY7z9e...SAMPLE_KEY_DATA.../O9wIDAQAB\",\r\n \"split\": true,\r\n \"escaped\": false,\r\n \"createdOn\": \"2025-08-08T14:36:31\",\r\n \"updatedOn\": \"0001-01-01T00:00:00\"\r\n }\r\n}"},{"id":"1f574bf2-e101-496a-bd53-2ac306cadbb6","name":"404:EntryNotFound","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v2/dkim/staged/:domain","host":["/"],"path":["v2","dkim","staged",":domain"],"variable":[{"key":"domain","value":"example.com"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"error\": [\r\n {\r\n \"errorType\": \"EntryNotFound\",\r\n \"message\": \"DKIM key is not found for the requested domain.\"\r\n }\r\n ]\r\n}"}],"_postman_id":"f6e32030-588b-4926-b1ac-3cb1216612aa"},{"name":"Update Staged Dkim","id":"f73af8aa-83e6-4c77-8934-1e7698222c81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"Selector\":\"dkim\",\r\n \"Split\":true,\r\n \"Escaped\":true\r\n}","options":{"raw":{"language":"json"}}},"url":"//v2/dkim/staged/:domain","description":"Update the staged DKIM domain on your Account
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","dkim","staged",":domain"],"host":["/"],"query":[],"variable":[{"id":"33c5bda9-7c54-4a93-b5fb-afa15b2c2baa","type":"any","value":"","key":"domain"}]}},"response":[{"id":"53cd9429-1744-43bb-b449-d400f118ba74","name":"200:Success","originalRequest":{"method":"PUT","header":[],"url":{"raw":"//v2/dkim/staged/:domain","host":["/"],"path":["v2","dkim","staged",":domain"],"variable":[{"key":"domain","value":""}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"serverId\": 12345,\r\n \"domain\": \"example.com\",\r\n \"selector\": \"selector1\",\r\n \"DnsRecord\": \"v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC8P2f6pNn1g3f5kY7z9e...SAMPLE_KEY_DATA.../O9wIDAQAB\",\r\n \"split\": true,\r\n \"escaped\": true,\r\n \"createdOn\": \"2025-08-08T14:36:31\",\r\n \"updatedOn\": \"2025-08-08T19:58:13.1532513Z\"\r\n }\r\n}"},{"id":"49937438-c0e0-41b8-8904-07fae32da6b5","name":"404:EntryNotFound","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"Selector\":\"dkim\",\r\n \"Split\":true,\r\n \"Escaped\":true\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"//v2/dkim/staged/:domain","host":["/"],"path":["v2","dkim","staged",":domain"],"variable":[{"key":"domain","value":""}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"error\": [\r\n {\r\n \"errorType\": \"EntryNotFound\",\r\n \"message\": \"DKIM key is not found for the requested domain.\"\r\n }\r\n ]\r\n}"},{"id":"a09a433d-4877-4f51-9065-1f4704a3c0d3","name":"400:InvalidRequestBody","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"Selector\":\"dkim\",\r\n \"Split\":true,\r\n \"Escaped\":true\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"//v2/dkim/staged/:domain","host":["/"],"path":["v2","dkim","staged",":domain"],"variable":[{"key":"domain","value":""}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"error\": [\r\n {\r\n \"errorType\": \"InvalidRequestBody\",\r\n \"message\": \"The request is invalid, request body may be missing.\"\r\n }\r\n ]\r\n}"}],"_postman_id":"f73af8aa-83e6-4c77-8934-1e7698222c81"},{"name":"Promote Staged Dkim","id":"cbadb225-8089-48c9-809b-f6148a37ab7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"//v2/dkim/staged/:domain/live","description":"Promote the staged DKIM domain on your Account to live
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","dkim","staged",":domain","live"],"host":["/"],"query":[],"variable":[{"id":"ba666261-eddf-4fda-bcb7-a658a9513234","type":"any","value":"","key":"domain"}]}},"response":[{"id":"137825d4-c957-4704-aebf-abbb43dfeb05","name":"200:Success","originalRequest":{"method":"POST","header":[],"url":{"raw":"//v2/dkim/staged/:domain/live","host":["/"],"path":["v2","dkim","staged",":domain","live"],"variable":[{"key":"domain","value":""}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"ServerId\": 12345,\r\n \"Domain\": \"example.com\",\r\n \"Selector\": \"selector1\",\r\n \"DnsRecord\": \"v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC8P2f6pNn1g3f5kY7z9e...SAMPLE_KEY_DATA.../O9wIDAQAB\",\r\n \"Split\": false,\r\n \"Escaped\": false,\r\n \"CreatedOn\": \"2025-08-08T20:08:58.987Z\",\r\n \"UpdatedOn\": \"2025-08-08T20:08:58.987Z\",\r\n \"Result\": \"Success\",\r\n \"ValidationResult\": \"Success\",\r\n \"GeneratedKey\": {\r\n \"DnsHostName\": \"selector1._domainkey.example.com\",\r\n \"Domain\": \"example.com\",\r\n \"Selector\": \"selector1\",\r\n \"DnsRecord\": \"v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC8P2f6pNn1g3f5kY7z9e...SAMPLE_KEY_DATA.../O9wIDAQAB\",\r\n \"PublicKey\": \"-----BEGIN PUBLIC KEY-----\\nMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC8P2f6pNn1g3f5kY7z9e...SAMPLE_KEY_DATA.../O9wIDAQAB\\n-----END PUBLIC KEY-----\",\r\n \"PrivateKey\": \"-----BEGIN RSA PRIVATE KEY-----\\nMIICXAIBAAKBgQC8P2f6pNn1g3f5kY7z9e...SAMPLE_KEY_DATA.../O9wIDAQAB\\nAoGBAI7...REST_OF_PRIVATE_KEY...\\n-----END RSA PRIVATE KEY-----\"\r\n },\r\n \"ShouldValidationDkim\": true,\r\n \"AccountIdentity\": true,\r\n \"ExcludeSLDkim\": false\r\n}"},{"id":"9d83ba1f-a6cf-4ee7-b13c-58b9d8f99309","name":"404:EntryNotFound","originalRequest":{"method":"POST","header":[],"url":{"raw":"//v2/dkim/staged/:domain/live","host":["/"],"path":["v2","dkim","staged",":domain","live"],"variable":[{"key":"domain","value":""}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"error\": [\r\n {\r\n \"errorType\": \"EntryNotFound\",\r\n \"message\": \"DKIM key is not found for the requested domain.\"\r\n }\r\n ]\r\n}"}],"_postman_id":"cbadb225-8089-48c9-809b-f6148a37ab7d"}],"id":"5c657215-dc59-4263-bd9e-3609e55388d7","_postman_id":"5c657215-dc59-4263-bd9e-3609e55388d7","description":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}}}],"id":"f9e9600e-ccf4-4d75-b14a-0a823dc54585","_postman_id":"f9e9600e-ccf4-4d75-b14a-0a823dc54585","description":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}}},{"name":"Subaccount","item":[{"name":"API Key Management","item":[{"name":"Get all API Keys for a subaccount","id":"5d5fd7b1-2adc-4f0a-99ae-52950d287d7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v2/subaccount/:subaccountId/credentials/api-key?pageSize=5&pageNumber=0&sortField=ipsum commodo Duis&sortDirection=dsc","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","subaccount",":subaccountId","credentials","api-key"],"host":["/"],"query":[{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"ipsum commodo Duis"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"8c5c4c46-ee54-463d-b630-4318067a3fcf","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerNumber of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"domain"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"1effd925-6ab8-478b-a6c7-d9ea2c63e114","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerStarting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"486fcb53-ee6e-4ba0-95d1-46113827aa52","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerStarting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"},{"description":{"content":"Type of aggregate to retrieve
\n","type":"text/plain"},"key":"type","value":"FromDomain"},{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"ipsum commodo Duis"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"fa32a2e5-45ae-4e2d-8728-da31166f9f4a","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerStarting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"},{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"queuedTime"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"c93ac14f-ba38-4253-8192-7b62b975826b","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerStarting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"41dc538d-d47c-418b-b467-06c4837ed58d","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerStarting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"},{"description":{"content":"Type of aggregate to retrieve
\n","type":"text/plain"},"key":"type","value":"ipsum commodo Duis"},{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"ipsum commodo Duis"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"12da1c1a-9e10-4a5a-844f-053245a59159","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerStarting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"},{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"ipsum commodo Duis"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"447c8afc-fff7-46bd-9665-5cb37a541c0e","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerYou can use these keys to update your DNS before creating new DKIM entries.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","subaccount",":subaccountId","dkim","generate"],"host":["/"],"query":[{"description":{"content":"(Required) The domain for the DKIM entry you are generating a key for.
\n","type":"text/plain"},"key":"domain","value":"example.com"},{"description":{"content":"(Required) The selector for the DKIM entry you are generating a key for.
\n","type":"text/plain"},"key":"selector","value":"dkim1"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"e21944e1-470d-4b70-a3ec-fedc25848875","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerNumber of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"domain"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"0b726d54-cdad-484b-9f97-7d29d0817133","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerEach entry will include the validation status for the domain.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","subaccount",":subaccountId","dkim",":domain"],"host":["/"],"query":[{"description":{"content":"(Optional) The selector for the DKIM entry you are querying..
\n","type":"text/plain"},"key":"selector","value":"dkim1"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"},{"type":"any","value":"example.com","key":"domain"}]}},"response":[{"id":"8669be18-b171-4621-86db-9d75826c505f","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerIf the PrivateKey is not provided, we will generate a new public/private key pair for you.\n Otherwise, we will attempt to validate your private key against the public key for your domain.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","subaccount",":subaccountId","dkim"],"host":["/"],"query":[],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"8418faf8-2f06-4d5a-a4a3-ee80cca6e4c0","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"BearerThe selector for the DKIM entry you are deleting.
\n","type":"text/plain"},"key":"selector","value":"dkim1"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"},{"type":"any","value":"example.com","key":"domain"}]}},"response":[{"id":"4e33ff88-3703-41fb-b80e-c6fd9b1399f6","name":"NoContent","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"BearerIf the PrivateKey is not provided,\nwe will generate a new public/private key pair for you. Otherwise, we will\nattempt to validate your private key against the public key for your domain.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","subaccount",":subaccountId","dkim","cname"],"host":["/"],"query":[],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"194219ff-a72b-406e-8700-544e96f77bf6","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"BearerNumber of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"domain"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"29216ab9-eb78-43ba-a493-0db0f8052994","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerThe start date in the format yyyy-MM-dd (required)
\n","type":"text/plain"},"key":"startDate","value":"ipsum commodo Duis"},{"description":{"content":"The end date in the format yyyy-MM-dd (required). Must be greater than or equal to the startDate
\n","type":"text/plain"},"key":"endDate","value":"ipsum commodo Duis"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"d2766f60-e2ef-42b4-a6e4-cae57a46eb9b","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerStarting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"},{"description":{"content":"Type of aggregate to retrieve
\n","type":"text/plain"},"key":"type","value":"ipsum commodo Duis"},{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"ipsum commodo Duis"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"7097477f-59c4-4018-a55c-02890be6ad7f","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerStarting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"},{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"ipsum commodo Duis"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"741872e7-2685-4b4e-b5c3-f05b79c6d972","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerNumber of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"eventUrl"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"335c4998-6b31-4b05-a1c3-7c44471f366c","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerRather than using an API to request and pull your message data, a webhook is a programmatic way to receive instant notifications pushed directly to your application.
\nNote: The following examples are used for setting up and testing your webhook endpoint. Please use the links in the Getting Started section for more information on the webhook events that we will send.
\n","_postman_id":"d1b6fc04-d669-4af7-9c20-6dbd722939a1","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}}},{"name":"Failures Report","item":[{"name":"Gets the failures overview data","id":"6ea8dbc2-3edd-44da-8f46-7e253e282330","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v2/subaccount/:subaccountId/reports/messages/failures/overview?startDate=2022-01-01&endDate=2022-01-31","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","subaccount",":subaccountId","reports","messages","failures","overview"],"host":["/"],"query":[{"description":{"content":"The start date in the format yyyy-MM-dd (required)
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"The end date in the format yyyy-MM-dd (required). Must be greater than or equal to the startDate
\n","type":"text/plain"},"key":"endDate","value":"2022-01-31"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"dbe72597-21af-4a81-b554-c9bbcb79ded0","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerStarting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"},{"description":{"content":"Type of aggregate to retrieve
\n","type":"text/plain"},"key":"type","value":"FromDomain"},{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"type"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"edca5e94-c6cc-42eb-ad9a-52120fbfd6c6","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerStarting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-14"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-14"},{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"queuedTime"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"9b7618f1-fd01-4dff-92fb-7757ec433d92","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearerthe email address to search
\n","type":"text/plain"},"key":"toEmailAddress","value":"recipient@example.com"},{"description":{"content":"Starting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-14"},{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"queuedTime"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"18b6c9aa-1858-4c24-aa7f-21319eaeb947","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearerthe requested date
\n","type":"text/plain"},"key":"requestDate","value":"2022-01-14"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"bada9ea4-78bb-47c1-bcd3-3329b096e429","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerRequires access to StreamScore Pro
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","subaccount",":subaccountId","streamscore","domains"],"host":["/"],"query":[{"description":{"content":"the requested date
\n","type":"text/plain"},"key":"requestDate","value":"2022-01-14"},{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"sendingDomain"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"8b186938-0682-406c-b6ed-c164a38a0486","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerRequires access to StreamScore Pro
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","subaccount",":subaccountId","streamscore",":sendingdomain"],"host":["/"],"query":[{"description":{"content":"the requested date
\n","type":"text/plain"},"key":"requestDate","value":"2022-01-14"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"},{"type":"any","value":"example.com","key":"sendingdomain"}]}},"response":[{"id":"141f0bb3-8bb1-4553-8123-66ee9e16adda","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerNumber of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"suppressionLastUpdate"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"18587365-1635-42ec-b0eb-1ce6039f786b","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerField used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"suppressionLastUpdate"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"c08a4303-f374-409c-bbe1-3650c3a757d7","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerEmail Address to search by
\n","type":"text/plain"},"key":"emailAddress","value":"test@example.com"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"c78cef49-2bb1-4a77-81b4-2e4ee419d59b","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerMax of 100 email addresses per call.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","subaccount",":subaccountId","suppressions","bulk"],"host":["/"],"query":[],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"7381062c-a762-49c6-a328-53f95b8e109a","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"BearerMax of 100 email addresses per call.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","subaccount",":subaccountId","suppressions","bulk-remove"],"host":["/"],"query":[],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"b1dd69e7-7388-44c6-bed8-bc98835a4da2","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"BearerEmail Address to search by
\n","type":"text/plain"},"key":"emailAddress","value":"test@example.com"}],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"4cb5f931-46e2-48ce-9b89-8bfae5669455","name":"No Content","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"BearerMust call GET first to generate a DKIM key. (/v2/subaccount/:subaccountId/email-forwarding/:domain/generate-dkim)
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","subaccount",":subaccountId","email-forwarding",":domain","generate-dkim"],"host":["/"],"query":[],"variable":[{"description":{"content":"(Required) Your SocketLabs Subaccount Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"subaccountId"},{"description":{"content":"(Required) (Optional) The domain for the DKIM entry you are querying.
\n","type":"text/plain"},"type":"any","value":"example.com","key":"domain"}]}},"response":[{"id":"620a4b58-0142-421a-a0cf-66976d60cc83","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerIf the PrivateKey is not provided, we will generate a new public/private key pair for you. Otherwise, we will attempt to validate your private key against the public key for your domain.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","subaccount",":subaccountId","email-forwarding",":domain","generate-dkim"],"host":["/"],"query":[],"variable":[{"description":{"content":"(Required) Your SocketLabs Subaccount Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"subaccountId"},{"description":{"content":"(Required) (Optional) The domain for the DKIM entry you are querying.
\n","type":"text/plain"},"type":"any","value":"example.com","key":"domain"}]}},"response":[{"id":"96002edc-b051-424b-b284-374234a0969b","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerMust call GET first to generate a DKIM key. (/v2/subaccount/:subaccountId/email-forwarding/:domain/generate-dkim)
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["subaccount",":subaccountId","email-forwarding",":domain","generate-dkim"],"host":["/v2"],"query":[],"variable":[{"description":{"content":"(Required) Your SocketLabs Subaccount Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"subaccountId"},{"description":{"content":"(Required) (Optional) The domain for the DKIM entry you are querying.
\n","type":"text/plain"},"type":"any","value":"example.com","key":"domain"}]}},"response":[{"id":"9634f8a6-5bea-4a59-93e7-c21d1197d59a","name":"Created","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required) Your SocketLabs Subaccount Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"subaccountId"},{"description":{"content":"(Required) (Optional) The domain for the DKIM entry you are querying.
\n","type":"text/plain"},"type":"any","value":"example.com","key":"domain"}]}},"response":[{"id":"24f61390-3f16-4980-a15c-7710b8c50467","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required) Your SocketLabs Subaccount Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"subaccountId"},{"description":{"content":"(Required) (Optional) The domain for the DKIM entry you are querying.
\n","type":"text/plain"},"type":"any","value":"example.com","key":"domain"}]}},"response":[{"id":"5413c8b6-ed52-4cf2-8421-4517c616a7b7","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required) Your SocketLabs Subaccount Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"subaccountId"},{"description":{"content":"(Required) The domain for the DKIM entry you are deleting.
\n","type":"text/plain"},"type":"any","value":"example.com","key":"domain"}]}},"response":[{"id":"a1eaf395-8fc6-419a-a127-79b4233b0619","name":"NoContent","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"BearerCreate, Update, or Delete a DKIM signature for a domain confgured for use with Email Forwarding
\n","_postman_id":"5bef56ca-0b8e-48f6-80a5-06ed9d9caa91","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}}},{"name":"Rules","item":[{"name":"Get all email forwarding rules for an email forwarding domain","id":"7241e564-98a2-4c00-a579-02c42ee0c4a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v2/subaccount/:subaccountId/email-forwarding/:domain/rules?pageSize=5&pageNumber=0&sortField=localPart&sortDirection=Asc","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","subaccount",":subaccountId","email-forwarding",":domain","rules"],"host":["/"],"query":[{"key":"pageSize","value":"5"},{"key":"pageNumber","value":"0"},{"key":"sortField","value":"localPart"},{"key":"sortDirection","value":"Asc"}],"variable":[{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"12345","key":"subaccountId"},{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"example.com","key":"domain"}]}},"response":[{"id":"80564490-96b3-4c4a-be71-253f8cf04e29","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required)
\n","type":"text/plain"},"type":"any","value":"12345","key":"subaccountId"},{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"example.com","key":"domain"},{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"12","key":"ruleId"}]}},"response":[{"id":"844fdd5d-b6e1-44a1-884e-110e58c3a21b","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required)
\n","type":"text/plain"},"type":"any","value":"12345","key":"subaccountId"},{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"example.com","key":"domain"}]}},"response":[{"id":"a1eee57b-c3ff-4ef0-9e74-7cc33a7f1ae1","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required)
\n","type":"text/plain"},"type":"any","value":"12345","key":"subaccountId"},{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"example.com","key":"domain"},{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"12","key":"ruleId"}]}},"response":[{"id":"d1d8bb97-e917-46fc-a472-e00300f9916b","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required)
\n","type":"text/plain"},"type":"any","value":"12345","key":"subaccountId"},{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"example.com","key":"domain"},{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"12","key":"ruleId"}]}},"response":[{"id":"b1bbc47d-93fa-429f-a50e-48bea35fbb8c","name":"NoContent","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer(Required)
\n","type":"text/plain"},"type":"any","value":"12345","key":"subaccountId"},{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"example.com","key":"domain"},{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"12","key":"ruleId"}]}},"response":[{"id":"11ad9f67-cbd7-447c-af7d-c211d1d7de0e","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required)
\n","type":"text/plain"},"type":"any","value":"12345","key":"subaccountId"},{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"example.com","key":"domain"},{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"12","key":"ruleId"}]}},"response":[{"id":"18215cdc-d9b4-4c5b-b9f7-fb574dee0bed","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required)
\n","type":"text/plain"},"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"517d8031-0d30-4abb-b466-a791731c92ef","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required)
\n","type":"text/plain"},"type":"any","value":"12345","key":"subaccountId"},{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"example.com","key":"domain"}]}},"response":[{"id":"0f1053df-4a70-49ec-97a4-ad8541299eba","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerMust have MX Records configured correctly to validate the domain. See https://help.socketlabs.com/docs/email-forwarding for more information.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","subaccount",":subaccountId","email-forwarding"],"host":["/"],"query":[],"variable":[{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"8de07c39-d6ba-48ca-9525-67bae08e3c1e","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerMust have MX Records configured correctly to validate the domain. See https://help.socketlabs.com/docs/email-forwarding for more information.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","subaccount",":subaccountId","email-forwarding",":domain"],"host":["/"],"query":[],"variable":[{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"12345","key":"subaccountId"},{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"example.com","key":"domain"}]}},"response":[{"id":"3f6ebf24-2043-45fc-9e73-22bdaf98e1c3","name":"Created","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer(Required)
\n","type":"text/plain"},"type":"any","value":"12345","key":"subaccountId"},{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"example.com","key":"domain"}]}},"response":[{"id":"006eadf2-4b50-49dc-8d2d-e8bf5bfe6f3e","name":"NoContent","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"BearerAPI Endpoints For Setting up and Configuring Email Forwarding for a SubAccount
\n","_postman_id":"0e59e089-8bec-4462-a793-196ab38ec51a","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}}},{"name":"SuperTag Key Management","item":[{"name":"Gets all SuperTag Keys","id":"fd1cb854-69c7-4ac4-8a99-4cfee7cfdf89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v2/subaccount/:subaccountId/super-tags/","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","id":"b4ab47e3-a279-49d6-a056-e8a5d4dda22c","name":"Complex Sender","type":"folder"}},"urlObject":{"path":["v2","subaccount",":subaccountId","super-tags",""],"host":["/"],"query":[],"variable":[{"type":"any","value":"12345","key":"subaccountId"}]}},"response":[{"id":"1adc4779-716d-4028-b22d-c4540d64f63d","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerFor Complex Sender and Simple Sender, regardless of version, an API key must be created on the API Key Management page in your SocketLabs account. Be sure to choose the `Injection Api` API Access option so your API key will have the correct access.
\nIt is important to keep your API key secure because it can be used to modify features for your SocketLabs account.
\nAll calls to the SocketLabs API are authenticated using the API key that you generated. Authenticate your calls to the SocketLabs API using the Authorization header with the Bearer authentication scheme.
Authorization: Bearer YOUR-API-KEY
If your application or system does not support the Bearer authentication scheme, you may also use the Basic scheme. If using the Basic scheme, you may use any string as the username and then your API key as the password. More information about Basic authentication can be found here.
Authorization: Basic YOUR-API-KEY
Your application should be designed to gracefully handle failure conditions and connectivity issues such as receiving no response or an error response from our API. The Injection API has several restrictions in place to prevent too great of an email volume from being injected in a single outbound message.
\nFor security reasons, the Injection API does not work directly from browser-based applications. If you attempt to access the API from the browser you will receive a CORS error such as:
\nAccess to XMLHttpRequest at ‘https://api.example.com/’ from origin ‘https://customerexample.com’ has been blocked by CORS policy: No ‘Access-Control-Allow-Origin’ header is present on the requested resource.
\nIn order to use the Injection API with your browser-based application, you must use an intermediary server to handle calls to the Injection API. This allows you to keep your API key secure. More information about this can be found in our blog.
\nThe specific restrictions regarding the properties of an individual injection request are as follows:
\nNo more than ten (10) outbound messages in a single injection request.
\nNo more than five hundred (500) recipients among all outbound messages in a single injection request. This means that there can be no more than fifty (50) recipients if the maximum number of ten (10) messages is being injected at once.
\nAn individual outbound message may have no more than fifty (50) recipients regardless of other restrictions.
\nThe sum of all outbound messages in a single injection request can be no more than 25MB in size.
\nIn addition to the above restrictions on content, the following throttling rules apply to this API:
\nWe allow up to five (5) injection requests per API key (or IP Address) per second.
\nWe allow up to five (5) authentication failures within a two (2) minute window per API key (or IP address). When this limit is reached, additional injection requests are blocked for the remainder of the two (2) minute window.
\nCurrent restrictions with all aspects of the API may change to allow greater volume and speed in the future.
\nIn order to make it easy to get started with the Injection API we provide client libraries in several different programming languages. When configuring the Injection API you can choose one of these languages to get a quick start with the library for your chosen language.
\nWe also maintain GitHub repositories for each of the client libraries. These repositories contain the full source code for the library, as well as detailed examples for many different use cases. We encourage you to take a look at these examples when getting started with the libary.
\nWe provide client libraries for the following languages:
\n\nThe Injection API is a versatile and malleable tool that can be used to send messages in a variety of fashions. This section will briefly go over the different types or way you can configure the JSON request to fulfill the needs of the messages you are sending.
\nA basic send is the simplest way to send a message through the Injection API. The most simple explanantion would be sending messages in this fashion would be similar to creating and sending a message through a common user-friendly program or application such as Outlook or Apple Mail. You add the content of a message and the To, From, CC and BCC recipients to the message and you can send it out. This method is basic in that you would generally only be sending the content of a single message to a single or a few recipients. It is important to note that If you plan on doing a basic send you will either need to have the PerMessage array set to null or not in the JSON at all. Please be aware that using the MergeData and PerMessage arrays our system disables the CC and BCC fields as they are redundant and not needed. Please see JSON samples for an example.
\nA bulk send is utilizing the Injection API to send a the content of a single message to mutliple recipients in such a manner that each recipient will receive the same message, but unlike with a message being sent from something like Outlook, each recipient will only see that the message was delivered to them. This sending method takes advantage of our MergeData and PerMessage arrays. This way you can customize a message for each recipient and by using our placeholder syntax in the To field ( %%DeliveryAddress%%) our system will recognize this placeholder and replace it with the address of each recipient defined in the PerMessage section of the JSON. This allows the API to build individual messages for each recipient keeping each message isolated from each other. Please see JSON Samples for an example.
\nWith the use of our MergeData and PerMessage arrays you can define additional placeholder fields in the Content of your messgaes and any of the other Field:Value pairs within the JSON. By setting the Value of a Field to a %%FieldName%% and then defining that in the PerMessage array for each recipient, it will be replaced by that value for each recipipent. This allows you to customize messages for each recipient.
\nThe Injection API supports the use of attachments of any kind. The only real requirement is that when defining the content of the attachment in the Content field, it must be a base64 encoded string. Anything else will result in an invalid data error being returned by our system.
\nSocketLabs API Templates allow software developers to programmatically send email content which is easily created in our new email designer. By separating the email content and design from the code, marketers and designers have full visibility into and control of the email content, design, and branding. Furthermore, email content can be updated without having to get developers involved, and without requiring changes to code or software deployments.
\nTo get started, first log into the SocketLabs On-Demand Control Panel and create some content. You may use our new drag and drop editor to create and save your content quickly and easily or you can create and save raw HTML and/or plain text content. Once you save your content, simply hover over its thumbnail in the Content Manager to get the associated API Template ID. Once you have the Template ID, this value is what you will provide in the “ApiTemplate” field in the JSON or XML that you pass with your API call. Please note that if you are using the “ApiTemplate” field, you’ll need to omit the “TextBody” and “HtmlBody” fields or your API call will result in a “MessageBodyConflict” error.
\nYou can also use our mail merging functionality in combination with the API Templates feature. Merge fields in your email content are declared using a ##FieldName## placeholder syntax, and any merge data included in your API call will replace the (matching named) placeholder text with the specified value. Any merge fields that are declared in your email content but do not have matching data in your API call will be left blank in the resulting message.
\nPlease see this blog article for a best example of using this feature.
\nThe following failure codes may be returned from the outbound email injection request inside of the PostResponse return object.
\nReturn codes within the PostResponse object, specifying the status of the injection request:
\nSuccess - No error.\nWarning – There were one or more failed messages and/or recipients.\nAccountDisabled - The account has been disabled.\nInternalError - Internal server error. (Please report to SocketLabs\n support if encountered.)\nInvalidAuthentication - The ServerId/ApiKey combination is invalid.\nInvalidData - PostBody parameter does not have a valid structure, or\n contains invalid or missing data.\nNoMessages - There were no messages to inject included in the request.\nEmptyMessage - One or more messages have insufficient content to process.\nOverQuota - Rate limit exceeded.\nTooManyErrors - Authentication error limit exceeded.\nTooManyMessages - Too many messages in a single request.\nTooManyRecipients - Too many recipients in a single message.\nNoValidRecipients - A merge was attempted, but there were no valid recipients.\n\nReturn codes within the MessageResult object, specifying the status of a specific message:
\nWarning - The message has one or more bad recipients.\nInvalidAttachment - The message has one or more invalid attachments.\nMessageTooLarge - The message was larger than the allowed size.\nEmptySubject - This message contained an empty subject line, which is not allowed.\nEmptyToAddress - This message does not contain a To address.\nInvalidFromAddress - This message does not contain a valid From address.\nNoValidBodyParts - This message does not have a valid text HTML body specified.\nNoValidRecipients - There are no valid addresses specified as message recipients.\nInvalidMergeData - The included merge data does not follow the API specification.\nInvalidTemplateId - The selected API Template does not exist.\nMessageBodyConflict - The Html Body and Text Body cannot be set when also specifying an API Template ID.\nMetadataOrTagsAreTooLarge - Metadata and tags exceed 12.5KB\n\nReturn codes within the AddressResult object, specifying the status of a specific recipient:
\nInvalidAddress - The address did not meet specification requirements.\n\nEvery endpoint that returns an array of results includes offset pagination. Offset pagination is defined by an order (`sortDirection`), a limit (`pageSize`), and an offset (`pageNumber`) from the start.
\nThe response type will include the data property containing the array of results and the total property containing the total number of results available
{\n \"data\": [\n …\n ],\n \"total\": 123\n}\n\nSometimes there will be errors with your API call. This could be due to any number of issues such as incorrect syntax, validation errors, limits being exceeded, or something going wrong on our server. When this happens the HTTP response will contain an error code, with additional information provided in the response body. The body can contain either a single error or a list of errors.
\n{\n \"error\" : [\n {\n \"errorType\": \"InvalidDomainFormat\",\n \"message\": \"Domain name not formatted correctly.\"\n }\n ]\n}\n\nNumber of records per page
\n","type":"text/plain"},"key":"pageSize","value":"10"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"apiKey"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"asc"}],"variable":[{"description":{"content":"(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"12ec76b5-5034-4aab-b68e-16412b367277","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"d3aa0266-c9e8-4421-a797-2a526232429e","name":"Created","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"description":{"content":"(Required) apiKeyId to update.
\n","type":"text/plain"},"type":"any","value":"123","key":"apiKeyId"}]}},"response":[{"id":"46a1905d-6e9f-49ee-84eb-5eb10bd9e460","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"description":{"content":"(Required) apiKeyId to delete.
\n","type":"text/plain"},"type":"any","value":"123","key":"apiKeyId"}]}},"response":[{"id":"dd88aa57-0e8f-4671-97e7-34f435c57845","name":"No Content","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"BearerSometimes there will be an error fulfilling your request. This will result in the standard Management API Error object. Here are some of the Error Types that you may encounter with the bounce domain endpoint, along with a brief description:
\n","_postman_id":"baeb16c9-ea44-4d9b-abb9-be5be05bb7a0","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9f207520-adda-4ff1-bb37-aa49bdff55b5","id":"9f207520-adda-4ff1-bb37-aa49bdff55b5","name":"Version 2","type":"folder"}}},{"name":"Get a Bounce Domain for Server","id":"85ca783d-d719-4c4d-a7bb-4fc1f495b856","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v2/servers/:serverId/bounce/:domain","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9f207520-adda-4ff1-bb37-aa49bdff55b5","id":"9f207520-adda-4ff1-bb37-aa49bdff55b5","name":"Version 2","type":"folder"}},"urlObject":{"path":["v2","servers",":serverId","bounce",":domain"],"host":["/"],"query":[],"variable":[{"description":{"content":"(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"description":{"content":"(Required) The bounce domain.
\n","type":"text/plain"},"type":"any","value":"bounce.example.com","key":"domain"}]}},"response":[{"id":"0e1e77f7-434d-49e8-938e-3ac48090c583","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerNumber of records per page
\n","type":"text/plain"},"key":"pageSize","value":"10"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"domain"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"asc"},{"disabled":true,"description":{"content":"Optional column filters
\n","type":"text/plain"},"key":"filters","value":"(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"6ae18d68-33a3-4ab6-9acc-6b7c7f8a5b49","name":"Created","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"description":{"content":"(Required) The bounce domain to be updated.
\n","type":"text/plain"},"type":"any","value":"bounce.example.com","key":"domain"}]}},"response":[{"id":"33fa7e84-0ae3-4908-b947-e761314b1f44","name":"Success","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"description":{"content":"(Required) The bounce domain to be deleted.
\n","type":"text/plain"},"type":"any","value":"bounce.example.com","key":"domain"}]}},"response":[{"id":"264acf9e-ae10-4636-b1f7-15a4f7e01a93","name":"NoContent","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThe Bounce Domains endpoint allows you to get a list of Bounce Domains for your server, add new domains, update an existing domain, or delete a domain.
\nBounce Domains will be used in the domain portion of the bounce address, which is used in the SMTP communication process to determine where the receiving mail server sends back its bounce and error messages. A custom bounce domain allows you to customize the domain utilized in the these email messages. For more information about this feature, please see the Custom Bounce Domains article in the SocketLabs Help Center.
\nIn order to set up a custom bounce domain, a CNAME record must be established with your DNS service provider. This CNAME must point a subdomain to the tracking.socketlabs.com domain. This can also be used for enabling the Engagement Tracking feature. You can re-use the CNAME record created for engagement tracking to customize your bounce domain. For more information about setting up a CNAME record for Custom Bounce Domains, please see the CNAME Configuration article in the SocketLabs Help Center.
Starting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"}],"variable":[{"description":{"content":"(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"6f750212-b207-4aa2-b6b2-d3f0c9fe4fe1","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerStarting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"},{"description":{"content":"Type of aggregate to retrieve
\n","type":"text/plain"},"key":"type","value":"FromDomain"},{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"type"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"description":{"content":"(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"0b7f6785-1e78-405b-9146-2f356cf23e13","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerStarting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"},{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"to"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"description":{"content":"(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"8d2ce972-0708-4476-858c-dded31439734","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerSometimes there will be an error fulfilling your request. This will result in the standard Management API Error object. Here are some of the Error Types that you may encounter with the DKIM endpoint, along with a brief description:
\n","_postman_id":"5b95389e-919d-48ca-b83e-d5f83d371cbe","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9f207520-adda-4ff1-bb37-aa49bdff55b5","id":"9f207520-adda-4ff1-bb37-aa49bdff55b5","name":"Version 2","type":"folder"}}},{"name":"Data Models","item":[],"id":"b33c97f8-752f-4ccf-a049-691f68973deb","description":"(Required)
\n","type":"text/plain"},"type":"any","value":"-6241228","key":"serverId"}]}},"response":[{"id":"7e5fe7d6-8b9b-4d2d-a518-9b4d2ca69b68","name":"Created","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"description":{"content":"(Required) The domain for the DKIM entry you are deleting.
\n","type":"text/plain"},"type":"any","value":"example.com","key":"domain"}]}},"response":[{"id":"687746d9-e4ab-4a84-a023-50c7d357be42","name":"NoContent","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerYou can use these keys to update your DNS before creating new DKIM entries.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9f207520-adda-4ff1-bb37-aa49bdff55b5","id":"9f207520-adda-4ff1-bb37-aa49bdff55b5","name":"Version 2","type":"folder"}},"urlObject":{"path":["v2","servers",":serverId","dkim","generate"],"host":["/"],"query":[{"description":{"content":"(Required) The domain for the DKIM entry you are generating a key for.
\n","type":"text/plain"},"key":"domain","value":"example.com"},{"description":{"content":"(Required) The selector for the DKIM entry you are generating a key for.
\n","type":"text/plain"},"key":"selector","value":"dkim1"}],"variable":[{"description":{"content":"(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"fef65f6d-395e-4001-b370-29a2a93f7b09","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerNumber of records per page
\n","type":"text/plain"},"key":"pageSize","value":"10"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"domain"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"asc"},{"disabled":true,"description":{"content":"Optional column filters
\n","type":"text/plain"},"key":"filters","value":"Each entry will include the validation status for the domain.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9f207520-adda-4ff1-bb37-aa49bdff55b5","id":"9f207520-adda-4ff1-bb37-aa49bdff55b5","name":"Version 2","type":"folder"}},"urlObject":{"path":["v2","servers",":serverId","dkim",":domain"],"host":["/"],"query":[{"description":{"content":"(Optional) The selector for the DKIM entry you are querying..
\n","type":"text/plain"},"key":"selector","value":"dkim1"}],"variable":[{"description":{"content":"(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"description":{"content":"(Required) (Optional) The domain for the DKIM entry you are querying.
\n","type":"text/plain"},"type":"any","value":"example.com","key":"domain"}]}},"response":[{"id":"31e65e6d-f227-4949-87e6-68ae51c797a8","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerIf the PrivateKey is not provided, we will generate a new public/private key pair for you.\n Otherwise, we will attempt to validate your private key against the public key for your domain.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9f207520-adda-4ff1-bb37-aa49bdff55b5","id":"9f207520-adda-4ff1-bb37-aa49bdff55b5","name":"Version 2","type":"folder"}},"urlObject":{"path":["v2","servers",":serverId","dkim"],"host":["/"],"query":[],"variable":[{"description":{"content":"(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"1afc2489-ffa4-42f8-abb2-c3650c4fe666","name":"Created","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"description":{"content":"(Required) (Required) The domain for the DKIM entry you are updating.
\n","type":"text/plain"},"type":"any","value":"example.com","key":"domain"}]}},"response":[{"id":"d82f5d89-8a73-4ab4-848f-b425c86be6a6","name":"Success","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThe selector for the DKIM entry you are deleting.
\n","type":"text/plain"},"key":"selector","value":"dkim1"}],"variable":[{"description":{"content":"(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"description":{"content":"(Required) The domain for the DKIM entry you are deleting.
\n","type":"text/plain"},"type":"any","value":"example.com","key":"domain"}]}},"response":[{"id":"3f502ecc-9cd7-4ebd-827f-60653a6a7f1c","name":"NoContent","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThe DKIM endpoint allows you to generate DKIM keys, save DKIM entries, and get a list of all DKIM entries for your server.
\nSocketLabs will sign outbound messages where the From address domain matches the domain for one of your DKIM entries. For more information about DKIM signing with SocketLabs, please see our Help Center.
\nIn order to create a new DKIM entry, please provide the domain, selector, and private key. We will attempt to validate the private key that you provide against the public key for your domain and selector. If we are unable to validate the public key, an error message will be returned.
\nYou can create your own private and public keys to use with this endpoint. If you would prefer to have SocketLabs generate the key pairs for you, we provide a Generate endpoint that will generate a public/private key pair for your provided domain and selector combination.
\n","_postman_id":"3c291d42-cb74-4f87-88c3-3ddf480abe5d","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9f207520-adda-4ff1-bb37-aa49bdff55b5","id":"9f207520-adda-4ff1-bb37-aa49bdff55b5","name":"Version 2","type":"folder"}}},{"name":"Delivered","item":[{"name":"Get Delivered Message Overview","id":"dd2e97e6-77ea-4732-bb87-3f8e651ec92d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v2/servers/:serverId/reports/messages/delivered/overview?startDate=2022-01-01&endDate=2022-01-05","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9f207520-adda-4ff1-bb37-aa49bdff55b5","id":"9f207520-adda-4ff1-bb37-aa49bdff55b5","name":"Version 2","type":"folder"}},"urlObject":{"path":["v2","servers",":serverId","reports","messages","delivered","overview"],"host":["/"],"query":[{"description":{"content":"Starting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"}],"variable":[{"description":{"content":"(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"be434697-3bb3-44d8-9ff9-53746953413a","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerStarting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"},{"description":{"content":"Type of aggregate to retrieve
\n","type":"text/plain"},"key":"type","value":"FromDomain"},{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"type"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"description":{"content":"(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"4d3e8aa0-ab33-4fa4-aa8d-acdbdec1c518","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerStarting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"},{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"to"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"description":{"content":"(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"44700bab-5983-40cf-801d-d0f515dccbd3","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerNumber of records per page
\n","type":"text/plain"},"key":"pageSize","value":"10"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"domain"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"asc"},{"disabled":true,"description":{"content":"Optional column filters
\n","type":"text/plain"},"key":"filters","value":"(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"5fba9bf9-5cfa-41cd-8bba-9eaeb15df030","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"description":{"content":"(Required) The domain for the tracking domain entry you are querying.
\n","type":"text/plain"},"type":"any","value":"tracking.example.com","key":"domain"}]}},"response":[{"id":"463261e7-fcfe-43b2-86d8-1a4585b61fb8","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"description":{"content":"(Required) The tracking domain to be updated.
\n","type":"text/plain"},"type":"any","value":"tracking.example.com","key":"domain"}]}},"response":[{"id":"2006dc2b-b93d-4475-83e0-07fa683da70e","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"4fe47107-fdb9-4dff-b817-da90d02f3540","name":"Created","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"description":{"content":"(Required) The domain for the tracking domain entry you are deleting.
\n","type":"text/plain"},"type":"any","value":"tracking.example.com","key":"domain"}]}},"response":[{"id":"9ff65ee0-9570-4c66-a7f5-ff555ffdc51a","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"description":{"content":"(Required) (Optional) The domain for the tracking domain entry you are querying.
\n","type":"text/plain"},"type":"any","value":"tracking.example.com","key":"domain"}]}},"response":[{"id":"1de303d4-f456-437e-a7f4-d7cd067fa94a","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"description":{"content":"(Required) The domain.
\n","type":"text/plain"},"type":"any","value":"tracking.example.com","key":"domain"}]}},"response":[{"id":"8421dfe1-bdf9-4a82-9c6f-3e8c794d202c","name":"NoContent","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"description":{"content":"(Required) The domain.
\n","type":"text/plain"},"type":"any","value":"tracking.example.com","key":"domain"}]}},"response":[{"id":"a7dfae8e-6025-4d6f-8b66-44e79d20b962","name":"Created","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThe Tracking Domain endpoint allows you to add, update or delete Tracking Domains for your server. Additionally, you can get a list of all Tracking Domain entries for your server or query for a single domain.
\nThe Engagement Tracking feature allows you to detect how your email recipients are interacting with messages sent to them; specifically, if they are opening the message, clicking on links within the message, or if the recipient has requested to be unsubscribed from the messages they are receiving.
\nIn order to use the Engagement Tracking feature, you must configure one or more Tracking Domains. Tracking Domains are used to white-label the links and images in your email messages, allowing the domains in the URL to match your own domain while still allowing SocketLabs to track engagement.
\nIn order to set up a Tracking Domain, a CNAME record must be established with your DNS service provider. This CNAME must point a subdomain to the tracking.socketlabs.com domain. This can also be used for enabling the Custom Bounce feature. You can re-use the CNAME record created for engagement tracking to customize your bounce domain. For more information about setting up a CNAME record for Tracking Domains, please see the CNAME Configuration article in the SocketLabs Help Center.
Sometimes there will be an error fulfilling your request. This will result in the standard Management API Error object. Here are some of the Error Types that you may encounter with the tracking domain endpoint, along with a brief description:
\n","_postman_id":"a19591b7-e768-45d6-8b00-703aa670df16","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9f207520-adda-4ff1-bb37-aa49bdff55b5","id":"9f207520-adda-4ff1-bb37-aa49bdff55b5","name":"Version 2","type":"folder"}}},{"name":"Tracking","item":[{"name":"Gets the Tracking Report overview data","id":"2cbccb77-e233-4cea-9303-7d4e185659e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v2/servers/:serverId/reports/messages/tracking/overview?startDate=2022-01-01&endDate=2022-01-05","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9f207520-adda-4ff1-bb37-aa49bdff55b5","id":"9f207520-adda-4ff1-bb37-aa49bdff55b5","name":"Version 2","type":"folder"}},"urlObject":{"path":["v2","servers",":serverId","reports","messages","tracking","overview"],"host":["/"],"query":[{"description":{"content":"The start date in the format yyyy-MM-dd (required)
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"The end date in the format yyyy-MM-dd (required). Must be greater than or equal to the startDate
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"}],"variable":[{"description":{"content":"(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"e0d811f7-3208-4c1e-b367-7ee0af4bee8f","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerStarting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"},{"description":{"content":"Type of aggregate to retrieve
\n","type":"text/plain"},"key":"type","value":"FromDomain"},{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"sent"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"description":{"content":"(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"34af5d99-f822-4034-b862-077ed5f9a19e","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerStarting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"},{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"to"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"description":{"content":"(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"31b99355-cd95-408e-bdf4-c9f1f7fb1d6d","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"type":"any","value":null,"key":"webhookId"}]}},"response":[{"id":"329605da-f5a0-4859-a1c2-3f9197d6bfef","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"type":"any","value":null,"key":"webhookId"}]}},"response":[{"id":"60bd27a5-da81-4b4c-bee7-d15cc9ca4231","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"type":"any","value":null,"key":"webhookId"}]}},"response":[{"id":"0a4b6f7c-0f23-4b02-9843-31b1022806c4","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"type":"any","value":null,"key":"webhookId"}]}},"response":[{"id":"0f6b9ac4-8ca2-4d3a-ac5e-27ae0f7349fd","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"type":"any","value":null,"key":"webhookId"}]}},"response":[{"id":"a6dc58e0-e6c3-4787-9d17-08714fc5c90a","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"type":"any","value":null,"key":"webhookId"}]}},"response":[{"id":"454f95da-20ba-49c8-8fbc-b6784413b22b","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"type":"any","value":null,"key":"webhookId"}]}},"response":[{"id":"77aa5e9a-dd2d-4f6b-b8a8-4aa37292ac0e","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"type":"any","value":null,"key":"webhookId"}]}},"response":[{"id":"61994749-888f-4569-8711-510cfc261589","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"1e1f99ca-642d-491b-a6a2-51c697b09a70","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerNumber of records per page
\n","type":"text/plain"},"key":"pageSize","value":"10"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"created"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"},{"disabled":true,"description":{"content":"Optional column filters
\n","type":"text/plain"},"key":"filters","value":"(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"12","key":"notificationWebhookId"}]}},"response":[{"id":"de07b3c5-3b6f-40e5-b63a-9848051b5be7","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"54af3628-3b8d-4e04-83b5-42397e01091a","name":"Created","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"type":"any","value":null,"key":"webhookId"}]}},"response":[{"id":"a8e2a9c0-9053-415c-80cb-beff175408c2","name":"Success","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"type":"any","value":null,"key":"webhookId"}]}},"response":[{"id":"1ff314bd-d9e5-4277-89ed-4cafec4b1efc","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"type":"any","value":null,"key":"webhookId"}]}},"response":[{"id":"47c1636e-f9ec-4a54-8db8-4a6aafda81ee","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerRather than using an API to request and pull your message data, a webhook is a programmatic way to receive instant notifications pushed directly to your application.
\nNote: The following examples are used for setting up and testing your webhook endpoint. Please use the links in the Getting Started section for more information on the webhook events that we will send.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"a48e116e-6bc6-4710-a832-59e51a372729","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f9af3ae9-53c7-4f82-9d3a-7bc1bcb5911b","type":"text/javascript","exec":[""]}}],"_postman_id":"f83dfb98-8b88-437d-a443-a519e6363099"},{"name":"Failures","item":[{"name":"Gets the failures overview data","id":"f9e39a2e-3982-4b0b-8e39-45bbf448f1db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v2/servers/:serverId/reports/messages/failures/overview?startDate=2022-01-01&endDate=2022-01-05","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9f207520-adda-4ff1-bb37-aa49bdff55b5","id":"9f207520-adda-4ff1-bb37-aa49bdff55b5","name":"Version 2","type":"folder"}},"urlObject":{"path":["v2","servers",":serverId","reports","messages","failures","overview"],"host":["/"],"query":[{"description":{"content":"The start date in the format yyyy-MM-dd (required)
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"The end date in the format yyyy-MM-dd (required). Must be greater than or equal to the startDate
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"}],"variable":[{"description":{"content":"(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"be272653-f49e-41cb-989e-c496b87efac3","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerStarting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"},{"description":{"content":"Type of aggregate to retrieve
\n","type":"text/plain"},"key":"type","value":"FromDomain"},{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"sent"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"description":{"content":"(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"d8b6047f-0b95-43b3-9a57-b5b96d8ebf64","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerStarting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-14"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-14"},{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"to"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"description":{"content":"(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"86fb63b8-ac15-4cce-b5a5-567f8e69d58c","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerStarting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"}],"variable":[{"description":{"content":"(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"fdeb9a38-d31e-4f6a-81b2-66e1839035c7","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerStarting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-05"},{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"to"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"description":{"content":"(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"6fdb25c6-a36d-4acf-96fb-ab00b49ff2d8","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"f7db87d8-8a42-4b32-a478-3ed99862a4d1","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"c1d3fdb1-79c4-4db9-8598-c3677f6fd5be","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"6dfbd37a-01f2-42b0-b046-212ba9924b94","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"3993c0f2-c937-4461-a9bc-55efe223d92d","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearerthe email address to search
\n","type":"text/plain"},"key":"toEmailAddress","value":"recipient@example.com"},{"description":{"content":"Starting date range to search
\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"Ending date range to search
\n","type":"text/plain"},"key":"endDate","value":"2022-01-14"},{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"pageSize","value":"5"},{"description":{"content":"Number of pages to off-set
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"Field used to sort the results
\n","type":"text/plain"},"key":"sortField","value":"to"},{"description":{"content":"Direction used in sorting
\n","type":"text/plain"},"key":"sortDirection","value":"dsc"}],"variable":[{"description":{"content":"(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"974fb3d6-892e-48c7-9a58-d01308531d43","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"123456789","key":"systemMessageId"}]}},"response":[{"id":"dd47ebd6-9755-4288-840a-43b9bb00841c","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"},{"description":{"content":"(Required) The sending domain.
\n","type":"text/plain"},"type":"any","value":"example.com","key":"domain"}]}},"response":[{"id":"1a2b8948-976f-482f-a74a-734224a05e8e","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerIn order to add a new Sending Domain, the domain must have a valid MX record or A record.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9f207520-adda-4ff1-bb37-aa49bdff55b5","id":"9f207520-adda-4ff1-bb37-aa49bdff55b5","name":"Version 2","type":"folder"}},"urlObject":{"path":["v2","servers",":serverId","sending-domains"],"host":["/"],"query":[],"variable":[{"description":{"content":"(Required) Your SocketLabs Server Id number.
\n","type":"text/plain"},"type":"any","value":"12345","key":"serverId"}]}},"response":[{"id":"0c84c5e1-ef44-4327-baf7-4caea6a5edcc","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer