{"items":[{"type":"link","label":"Mailgun API","link":"/docs/mailgun/api-reference/send/mailgun","routeSlug":"/docs/mailgun/api-reference/send/mailgun","content":{"contentType":"overview","meta":{"name":"Mailgun API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"mailgun.json","url":"/_bundle/docs/mailgun/api-reference/send/mailgun.json?download"},{"kind":"download","label":"mailgun.yaml","url":"/_bundle/docs/mailgun/api-reference/send/mailgun.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Mailgun API (3.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Mailgun API defined by OpenAPI Specification (OAS) 3.1.0"}],"sectionId":"/docs/mailgun/api-reference/send/mailgun"}],"sectionId":"/docs/mailgun/api-reference/send/mailgun"}]}]}},{"type":"separator","label":"Messages","content":null},{"type":"group","label":"Messages","link":"/docs/mailgun/api-reference/send/mailgun/messages","routeSlug":"/docs/mailgun/api-reference/send/mailgun/messages","items":[{"label":"Send an email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/messages/post-v3--domain-name--messages","routeSlug":"/docs/mailgun/api-reference/send/mailgun/messages/post-v3--domain-name--messages","metadata":{"seo":{"title":"Send an email","description":"Pass the components of the messages such as To, From, Subject, HTML, text parts, attachments, etc. Mailgun will build a MIME representation of the message and send it. In order to send you must provide one of the following parameters: 'text', 'html', 'amp-html' or 'template'. Important: Send options (parameters starting with o:, h:, v:, or t:) are limited to 16KB total"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3--domain-name--messages","name":"Send an email","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1messages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send an email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Pass the components of the messages such as To, From, Subject, HTML, text parts, attachments, etc. Mailgun will build a MIME representation of the message and send it. In order to send you must provide one of the following parameters: 'text', 'html', 'amp-html' or 'template'. Important: Send options (parameters starting with o:, h:, v:, or t:) are limited to 16KB total"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain name used to send the message","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1messages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domain_name-messages-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/POST-v3-domain_name-messages-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1{domain_name}~1messages/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/{domain_name}/messages","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domain_name-messages-multipart-form-data-RequestBody"}},"responseCodes":["200","400","401","429","500"],"pointer":"/v3/{domain_name}/messages","href":"messages/post-v3--domain-name--messages","openApiOperationId":"POST-v3--domain-name--messages","summary":"Send an email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/POST-v3-domain_name-messages-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domain_name-messages-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-SendMessageResponse","exampleIds":["paths/~1v3~1{domain_name}~1messages/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-SendMessageResponse","exampleIds":["paths/~1v3~1{domain_name}~1messages/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1{domain_name}~1messages/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1{domain_name}~1messages/post/responses/400/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1{domain_name}~1messages/post/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1{domain_name}~1messages/post/responses/401/content/application~1json/examples/Example"]},{"code":"429","description":"A 429 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1{domain_name}~1messages/post/responses/429/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1{domain_name}~1messages/post/responses/429/content/application~1json/examples/Example"]},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1{domain_name}~1messages/post/responses/500/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1{domain_name}~1messages/post/responses/500/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain_name}~1messages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-influx-httpapi-SendMessageResponse","exampleIds":["paths/~1v3~1{domain_name}~1messages/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-SendMessageResponse","exampleIds":["paths/~1v3~1{domain_name}~1messages/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1{domain_name}~1messages/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1{domain_name}~1messages/post/responses/400/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1{domain_name}~1messages/post/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1{domain_name}~1messages/post/responses/401/content/application~1json/examples/Example"]}}},{"code":"429","schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1{domain_name}~1messages/post/responses/429/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1{domain_name}~1messages/post/responses/429/content/application~1json/examples/Example"]}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1{domain_name}~1messages/post/responses/500/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1{domain_name}~1messages/post/responses/500/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/messages/post-v3--domain-name--messages"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/messages"},{"label":"Send an email in MIME format","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/messages/post-v3--domain-name--messages-mime","routeSlug":"/docs/mailgun/api-reference/send/mailgun/messages/post-v3--domain-name--messages-mime","metadata":{"seo":{"title":"Send an email in MIME format","description":"Build a MIME string yourself using a MIME library and submit it to Mailgun. Important: Send options (parameters starting with o:, h:, v:, or t:) are limited to 16KB total"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3--domain-name--messages-mime","name":"Send an email in MIME format","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1messages.mime/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send an email in MIME format","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Build a MIME string yourself using a MIME library and submit it to Mailgun. Important: Send options (parameters starting with o:, h:, v:, or t:) are limited to 16KB total"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain name used to send the message","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1messages.mime/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domain_name-messages-mime-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/POST-v3-domain_name-messages-mime-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1{domain_name}~1messages.mime/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/{domain_name}/messages.mime","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domain_name-messages-mime-multipart-form-data-RequestBody"}},"responseCodes":["200","400","401","429","500"],"pointer":"/v3/{domain_name}/messages.mime","href":"messages/post-v3--domain-name--messages-mime","openApiOperationId":"POST-v3--domain-name--messages-mime","summary":"Send an email in MIME format"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/POST-v3-domain_name-messages-mime-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domain_name-messages-mime-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-SendMessageResponse","exampleIds":["paths/~1v3~1{domain_name}~1messages.mime/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-SendMessageResponse","exampleIds":["paths/~1v3~1{domain_name}~1messages.mime/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1{domain_name}~1messages.mime/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1{domain_name}~1messages.mime/post/responses/400/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1{domain_name}~1messages.mime/post/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1{domain_name}~1messages.mime/post/responses/401/content/application~1json/examples/Example"]},{"code":"429","description":"A 429 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1{domain_name}~1messages.mime/post/responses/429/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1{domain_name}~1messages.mime/post/responses/429/content/application~1json/examples/Example"]},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1{domain_name}~1messages.mime/post/responses/500/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1{domain_name}~1messages.mime/post/responses/500/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain_name}~1messages.mime/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-influx-httpapi-SendMessageResponse","exampleIds":["paths/~1v3~1{domain_name}~1messages.mime/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-SendMessageResponse","exampleIds":["paths/~1v3~1{domain_name}~1messages.mime/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1{domain_name}~1messages.mime/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1{domain_name}~1messages.mime/post/responses/400/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1{domain_name}~1messages.mime/post/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1{domain_name}~1messages.mime/post/responses/401/content/application~1json/examples/Example"]}}},{"code":"429","schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1{domain_name}~1messages.mime/post/responses/429/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1{domain_name}~1messages.mime/post/responses/429/content/application~1json/examples/Example"]}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1{domain_name}~1messages.mime/post/responses/500/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1{domain_name}~1messages.mime/post/responses/500/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/messages/post-v3--domain-name--messages-mime"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/messages.mime"},{"label":"Retrieve a stored email","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/messages/get-v3-domains--domain-name--messages--storage-key-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/messages/get-v3-domains--domain-name--messages--storage-key-","metadata":{"seo":{"title":"Retrieve a stored email","description":"Event(s) created from sending an email with Mailgun will contain a storage.key to use to retrieve the email."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-domains--domain-name--messages--storage-key-","name":"Retrieve a stored email","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{domain_name}~1messages~1{storage_key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a stored email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event(s) created from sending an email with Mailgun will contain a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"storage.key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to use to retrieve the email."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain name that was used to send the email","required":true},{"name":"storage_key","in":"path","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Storage key from the email's associated events (Example: Accepted/Delivered events "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"storage.key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field). Note: Storage keys are available for the duration of your domain's message retention policy."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v3~1domains~1{domain_name}~1messages~1{storage_key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/domains/{domain_name}/messages/{storage_key}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"storage_key","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/v3/domains/{domain_name}/messages/{storage_key}","href":"messages/get-v3-domains--domain-name--messages--storage-key-","openApiOperationId":"GET-v3-domains--domain-name--messages--storage-key-","summary":"Retrieve a stored email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseBasicExample","exampleIds":["paths/~1v3~1domains~1{domain_name}~1messages~1{storage_key}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseBasicExample","exampleIds":["paths/~1v3~1domains~1{domain_name}~1messages~1{storage_key}/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound"}},"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1domains~1{domain_name}~1messages~1{storage_key}/get/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1domains~1{domain_name}~1messages~1{storage_key}/get/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{domain_name}~1messages~1{storage_key}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseBasicExample","exampleIds":["paths/~1v3~1domains~1{domain_name}~1messages~1{storage_key}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseBasicExample","exampleIds":["paths/~1v3~1domains~1{domain_name}~1messages~1{storage_key}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1domains~1{domain_name}~1messages~1{storage_key}/get/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","exampleIds":["paths/~1v3~1domains~1{domain_name}~1messages~1{storage_key}/get/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/messages/get-v3-domains--domain-name--messages--storage-key-"}],"panels":[]}]},"httpPath":"/v3/domains/{domain_name}/messages/{storage_key}"},{"label":"Resend an email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/messages/post-v3-domains--domain-name--messages--storage-key-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/messages/post-v3-domains--domain-name--messages--storage-key-","metadata":{"seo":{"title":"Resend an email","description":"Resend an email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3-domains--domain-name--messages--storage-key-","name":"Resend an email","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{domain_name}~1messages~1{storage_key}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resend an email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain name used to send the message","required":true},{"name":"storage_key","in":"path","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Storage key from the email's associated events (Example: Accepted/Delivered events "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"storage.key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field). Note: Storage keys are available for the duration of your domain's message retention policy."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v3~1domains~1{domain_name}~1messages~1{storage_key}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domains-domain_name-messages-storage_key-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/POST-v3-domains-domain_name-messages-storage_key-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1domains~1{domain_name}~1messages~1{storage_key}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/domains/{domain_name}/messages/{storage_key}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"storage_key","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domains-domain_name-messages-storage_key-multipart-form-data-RequestBody"}},"responseCodes":["200"],"pointer":"/v3/domains/{domain_name}/messages/{storage_key}","href":"messages/post-v3-domains--domain-name--messages--storage-key-","openApiOperationId":"POST-v3-domains--domain-name--messages--storage-key-","summary":"Resend an email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/POST-v3-domains-domain_name-messages-storage_key-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domains-domain_name-messages-storage_key-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-SendMessageResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1messages~1{storage_key}/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-SendMessageResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1messages~1{storage_key}/post/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{domain_name}~1messages~1{storage_key}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-influx-httpapi-SendMessageResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1messages~1{storage_key}/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-influx-httpapi-SendMessageResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1messages~1{storage_key}/post/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/messages/post-v3-domains--domain-name--messages--storage-key-"}],"panels":[]}]},"httpPath":"/v3/domains/{domain_name}/messages/{storage_key}"},{"label":"Get messages queue status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/messages/get-v3-domains--name--sending-queues","routeSlug":"/docs/mailgun/api-reference/send/mailgun/messages/get-v3-domains--name--sending-queues","metadata":{"seo":{"title":"Get messages queue status","description":"Provides default and scheduled message queue information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-domains--name--sending-queues","name":"Get messages queue status","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{name}~1sending_queues/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get messages queue status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Provides default and scheduled message queue information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"The name of the domain you want get sending queues from","required":true}],"pointer":"/paths/~1v3~1domains~1{name}~1sending_queues/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/domains/{name}/sending_queues","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/domains/{name}/sending_queues","href":"messages/get-v3-domains--name--sending-queues","openApiOperationId":"GET-v3-domains--name--sending-queues","summary":"Get messages queue status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetDomainSendingQueuesResp","exampleIds":["paths/~1v3~1domains~1{name}~1sending_queues/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetDomainSendingQueuesResp","exampleIds":["paths/~1v3~1domains~1{name}~1sending_queues/get/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1sending_queues/get/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1sending_queues/get/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1sending_queues/get/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1sending_queues/get/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{name}~1sending_queues/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetDomainSendingQueuesResp","exampleIds":["paths/~1v3~1domains~1{name}~1sending_queues/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetDomainSendingQueuesResp","exampleIds":["paths/~1v3~1domains~1{name}~1sending_queues/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1sending_queues/get/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1sending_queues/get/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1sending_queues/get/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1sending_queues/get/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/messages/get-v3-domains--name--sending-queues"}],"panels":[]}]},"httpPath":"/v3/domains/{name}/sending_queues"},{"label":"Delete scheduled and undelivered mail","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/messages/delete-v3--domain-name--envelopes","routeSlug":"/docs/mailgun/api-reference/send/mailgun/messages/delete-v3--domain-name--envelopes","metadata":{"seo":{"title":"Delete scheduled and undelivered mail","description":"Deletes all scheduled and undelivered mail from the domain queue.  This endpoint must be called on the same storage API host as the mail's generated storage URL.  e.g. https://storage-us-east4.api.mailgun.net/v3/example.com/envelopes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3--domain-name--envelopes","name":"Delete scheduled and undelivered mail","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1envelopes/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete scheduled and undelivered mail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes all scheduled and undelivered mail from the domain queue.  This endpoint must be called on the same storage API host as the mail's generated storage URL.  e.g. https://storage-us-east4.api.mailgun.net/v3/example.com/envelopes"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The storage hosts are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"storage-us-east4.api.mailgun.net"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"storage-us-west1.api.mailgun.net"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"storage-europe-west1.api.mailgun.net"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"The name of the domain you want to delete envelope from","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1envelopes/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/{domain_name}/envelopes","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/{domain_name}/envelopes","href":"messages/delete-v3--domain-name--envelopes","openApiOperationId":"DELETE-v3--domain-name--envelopes","summary":"Delete scheduled and undelivered mail"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1envelopes/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1envelopes/delete/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1envelopes/delete/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1envelopes/delete/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1envelopes/delete/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1envelopes/delete/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain_name}~1envelopes/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1envelopes/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1envelopes/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1envelopes/delete/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1envelopes/delete/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1envelopes/delete/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1envelopes/delete/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/messages/delete-v3--domain-name--envelopes"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/envelopes"}],"content":{"contentType":"group","meta":{"name":"Messages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Messages","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send email two ways via our REST API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send emails using MIME format using a MIME building library"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit the individual parts (Text, html, attachments, etc.)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reminder: You can also send email via SMTP with Mailgun. Please reference the user manual."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/{domain_name}/messages","summary":"Send an email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/messages/post-v3--domain-name--messages","deprecated":false},{"title":"/v3/{domain_name}/messages.mime","summary":"Send an email in MIME format","prefix":{"name":"post","color":"post"},"badges":[],"link":"/messages/post-v3--domain-name--messages-mime","deprecated":false},{"title":"/v3/domains/{domain_name}/messages/{storage_key}","summary":"Retrieve a stored email","prefix":{"name":"get","color":"get"},"badges":[],"link":"/messages/get-v3-domains--domain-name--messages--storage-key-","deprecated":false},{"title":"/v3/domains/{domain_name}/messages/{storage_key}","summary":"Resend an email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/messages/post-v3-domains--domain-name--messages--storage-key-","deprecated":false},{"title":"/v3/domains/{name}/sending_queues","summary":"Get messages queue status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/messages/get-v3-domains--name--sending-queues","deprecated":false},{"title":"/v3/{domain_name}/envelopes","summary":"Delete scheduled and undelivered mail","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/messages/delete-v3--domain-name--envelopes","deprecated":false}]}]}]}]}},{"type":"separator","label":"Domains","content":null},{"type":"group","label":"Domains","link":"/docs/mailgun/api-reference/send/mailgun/domains","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domains","items":[{"label":"Get domains","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domains/get-v4-domains","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domains/get-v4-domains","metadata":{"seo":{"title":"Get domains","description":"Get the list of domains. Can be filtered by state or authority. Sorting is optional. The list is paginated and limited to 1000 items per page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v4-domains","name":"Get domains","isWebhook":false,"pointer":"/paths/~1v4~1domains/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get domains","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the list of domains. Can be filtered by state or authority. Sorting is optional. The list is paginated and limited to 1000 items per page."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_260","description":"Max count of items. Max: 1000. Default: 100"},{"name":"skip","in":"query","schemaId":"schema_260","description":"Get the list of items starting at the nth element. Default: 0"},{"name":"state","in":"query","schemaId":"components/schemas/string","description":"Get only domains with a specific state. Can be either active, unverified or disabled."},{"name":"sort","in":"query","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid sort options are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which defaults to asc order, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name:asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name:desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If sorting is not specified domains are returned in reverse creation date order."},"children":[]}]}]}]},{"name":"authority","in":"query","schemaId":"components/schemas/string","description":"Get only domains with a specific authority. If state is specified then only state filtering will be proceed"},{"name":"search","in":"query","schemaId":"components/schemas/string","description":"Search domains by the given partial or complete name. Does not support wildcards"},{"name":"include_subaccounts","in":"query","schemaId":"schema_261","description":"Search on every domain that belongs to any subaccounts under this account. Default to false."}],"pointer":"/paths/~1v4~1domains/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/domains","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_260"},{"name":"skip","in":"query","schemaId":"schema_260"},{"name":"state","in":"query","schemaId":"components/schemas/string"},{"name":"sort","in":"query","schemaId":"components/schemas/string"},{"name":"authority","in":"query","schemaId":"components/schemas/string"},{"name":"search","in":"query","schemaId":"components/schemas/string"},{"name":"include_subaccounts","in":"query","schemaId":"schema_261"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v4/domains","href":"domains/get-v4-domains","openApiOperationId":"GET-v4-domains","summary":"Get domains"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-ListDomainResponse","exampleIds":["paths/~1v4~1domains/get/responses/200/content/application~1json/examples/200 without subaccount domains","paths/~1v4~1domains/get/responses/200/content/application~1json/examples/200 with subaccount domains"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-ListDomainResponse","exampleIds":["paths/~1v4~1domains/get/responses/200/content/application~1json/examples/200 without subaccount domains","paths/~1v4~1domains/get/responses/200/content/application~1json/examples/200 with subaccount domains"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains/get/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains/get/responses/401/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v4~1domains/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-ListDomainResponse","exampleIds":["paths/~1v4~1domains/get/responses/200/content/application~1json/examples/200 without subaccount domains","paths/~1v4~1domains/get/responses/200/content/application~1json/examples/200 with subaccount domains"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-ListDomainResponse","exampleIds":["paths/~1v4~1domains/get/responses/200/content/application~1json/examples/200 without subaccount domains","paths/~1v4~1domains/get/responses/200/content/application~1json/examples/200 with subaccount domains"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains/get/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains/get/responses/401/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domains/get-v4-domains"}],"panels":[]}]},"httpPath":"/v4/domains"},{"label":"Create a domain","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domains/post-v4-domains","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domains/post-v4-domains","metadata":{"seo":{"title":"Create a domain","description":"Creates a domain for sending emails"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v4-domains","name":"Create a domain","isWebhook":false,"pointer":"/paths/~1v4~1domains/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a domain for sending emails"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v4-domains-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/POST-v4-domains-multipart-form-data-RequestBody","pointer":"/paths/~1v4~1domains/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/domains","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/POST-v4-domains-multipart-form-data-RequestBody"}},"responseCodes":["200","400","401"],"pointer":"/v4/domains","href":"domains/post-v4-domains","openApiOperationId":"POST-v4-domains","summary":"Create a domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/POST-v4-domains-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v4-domains-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-CreateDomainResp","exampleIds":["paths/~1v4~1domains/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-CreateDomainResp","exampleIds":["paths/~1v4~1domains/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains/post/responses/400/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains/post/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains/post/responses/401/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v4~1domains/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-CreateDomainResp","exampleIds":["paths/~1v4~1domains/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-CreateDomainResp","exampleIds":["paths/~1v4~1domains/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains/post/responses/400/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains/post/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains/post/responses/401/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domains/post-v4-domains"}],"panels":[]}]},"httpPath":"/v4/domains"},{"label":"Get domain details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domains/get-v4-domains--name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domains/get-v4-domains--name-","metadata":{"seo":{"title":"Get domain details","description":"Fetches json representation of a domain that includes details about the domain's state and settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v4-domains--name-","name":"Get domain details","isWebhook":false,"pointer":"/paths/~1v4~1domains~1{name}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get domain details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches json representation of a domain that includes details about the domain's state and settings."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"The name of the domain you want to fetch","required":true}],"pointer":"/paths/~1v4~1domains~1{name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/domains/{name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v4/domains/{name}","href":"domains/get-v4-domains--name-","openApiOperationId":"GET-v4-domains--name-","summary":"Get domain details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-FindDomainByNameResp","exampleIds":["paths/~1v4~1domains~1{name}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-FindDomainByNameResp","exampleIds":["paths/~1v4~1domains~1{name}/get/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{name}/get/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{name}/get/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{name}/get/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{name}/get/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v4~1domains~1{name}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-FindDomainByNameResp","exampleIds":["paths/~1v4~1domains~1{name}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-FindDomainByNameResp","exampleIds":["paths/~1v4~1domains~1{name}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{name}/get/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{name}/get/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{name}/get/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{name}/get/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domains/get-v4-domains--name-"}],"panels":[]}]},"httpPath":"/v4/domains/{name}"},{"label":"Update domain","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domains/put-v4-domains--name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domains/put-v4-domains--name-","metadata":{"seo":{"title":"Update domain","description":"Update domain configuration like smtp credentials, enable/disable automatic sender security, spam actions, wildcard, or tracking web scheme."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v4-domains--name-","name":"Update domain","isWebhook":false,"pointer":"/paths/~1v4~1domains~1{name}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update domain configuration like smtp credentials, enable/disable automatic sender security, spam actions, wildcard, or tracking web scheme."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"The name of the domain you want to update","required":true}],"pointer":"/paths/~1v4~1domains~1{name}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v4-domains-name-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/PUT-v4-domains-name-multipart-form-data-RequestBody","pointer":"/paths/~1v4~1domains~1{name}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v4/domains/{name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v4-domains-name-multipart-form-data-RequestBody"}},"responseCodes":["200","401","404"],"pointer":"/v4/domains/{name}","href":"domains/put-v4-domains--name-","openApiOperationId":"PUT-v4-domains--name-","summary":"Update domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/PUT-v4-domains-name-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v4-domains-name-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainResp","exampleIds":["paths/~1v4~1domains~1{name}/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainResp","exampleIds":["paths/~1v4~1domains~1{name}/put/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{name}/put/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{name}/put/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{name}/put/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{name}/put/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v4~1domains~1{name}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainResp","exampleIds":["paths/~1v4~1domains~1{name}/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainResp","exampleIds":["paths/~1v4~1domains~1{name}/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{name}/put/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{name}/put/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{name}/put/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{name}/put/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domains/put-v4-domains--name-"}],"panels":[]}]},"httpPath":"/v4/domains/{name}"},{"label":"Verify Domain","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domains/put-v4-domains--name--verify","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domains/put-v4-domains--name--verify","metadata":{"seo":{"title":"Verify Domain","description":"Verify the domains DNS records (includes A, CNAME, SPF, DKIM and MX records) to ensure the domain is ready and able to send"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v4-domains--name--verify","name":"Verify Domain","isWebhook":false,"pointer":"/paths/~1v4~1domains~1{name}~1verify/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify Domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Verify the domains DNS records (includes A, CNAME, SPF, DKIM and MX records) to ensure the domain is ready and able to send"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"The name of the domain you want to verify","required":true}],"pointer":"/paths/~1v4~1domains~1{name}~1verify/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v4/domains/{name}/verify","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404","429"],"pointer":"/v4/domains/{name}/verify","href":"domains/put-v4-domains--name--verify","openApiOperationId":"PUT-v4-domains--name--verify","summary":"Verify Domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-VerifyDomainResponse","exampleIds":["paths/~1v4~1domains~1{name}~1verify/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-VerifyDomainResponse","exampleIds":["paths/~1v4~1domains~1{name}~1verify/put/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{name}~1verify/put/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{name}~1verify/put/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{name}~1verify/put/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{name}~1verify/put/responses/404/content/application~1json/examples/Example"]},{"code":"429","description":"A 429 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v4~1domains~1{name}~1verify/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-VerifyDomainResponse","exampleIds":["paths/~1v4~1domains~1{name}~1verify/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-VerifyDomainResponse","exampleIds":["paths/~1v4~1domains~1{name}~1verify/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{name}~1verify/put/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{name}~1verify/put/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{name}~1verify/put/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{name}~1verify/put/responses/404/content/application~1json/examples/Example"]}}},{"code":"429","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domains/put-v4-domains--name--verify"}],"panels":[]}]},"httpPath":"/v4/domains/{name}/verify"},{"label":"Delete a domain","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domains/delete-v3-domains--name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domains/delete-v3-domains--name-","metadata":{"seo":{"title":"Delete a domain","description":"The domain must not be disabled or used as an authority for an other domain. Sandbox domain can't be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3-domains--name-","name":"Delete a domain","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{name}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The domain must not be disabled or used as an authority for an other domain. Sandbox domain can't be deleted."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"The name of the domain to delete","required":true}],"pointer":"/paths/~1v3~1domains~1{name}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/domains/{name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/domains/{name}","href":"domains/delete-v3-domains--name-","openApiOperationId":"DELETE-v3-domains--name-","summary":"Delete a domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}/delete/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}/delete/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}/delete/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}/delete/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}/delete/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{name}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}/delete/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}/delete/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}/delete/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}/delete/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domains/delete-v3-domains--name-"}],"panels":[]}]},"httpPath":"/v3/domains/{name}"}],"content":{"contentType":"group","meta":{"name":"Domains"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Domains","showPageActions":true},{"nodeType":"markdoc","content":"Domains API manages domains, domain keys and DNS verification."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/domains","summary":"Get domains","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domains/get-v4-domains","deprecated":false},{"title":"/v4/domains","summary":"Create a domain","prefix":{"name":"post","color":"post"},"badges":[],"link":"/domains/post-v4-domains","deprecated":false},{"title":"/v4/domains/{name}","summary":"Get domain details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domains/get-v4-domains--name-","deprecated":false},{"title":"/v4/domains/{name}","summary":"Update domain","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domains/put-v4-domains--name-","deprecated":false},{"title":"/v4/domains/{name}/verify","summary":"Verify Domain","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domains/put-v4-domains--name--verify","deprecated":false},{"title":"/v3/domains/{name}","summary":"Delete a domain","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/domains/delete-v3-domains--name-","deprecated":false}]}]}]}]}},{"type":"group","label":"Domain Keys","link":"/docs/mailgun/api-reference/send/mailgun/domain-keys","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-keys","items":[{"label":"List keys for all domains","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-keys/get-v1-dkim-keys","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-keys/get-v1-dkim-keys","metadata":{"seo":{"title":"List keys for all domains","description":"List domain keys, and optionally filter by signing domain or selector. Results are paginated - use the 'limit' parameter to control page size (default 10, max 100). Use the 'page' parameter from the paging response URLs to navigate through pages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-dkim-keys","name":"List keys for all domains","isWebhook":false,"pointer":"/paths/~1v1~1dkim~1keys/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List keys for all domains","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List domain keys, and optionally filter by signing domain or selector. Results are paginated - use the 'limit' parameter to control page size (default 10, max 100). Use the 'page' parameter from the paging response URLs to navigate through pages."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/GET-v1-dkim-keys-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/GET-v1-dkim-keys-multipart-form-data-RequestBody","pointer":"/paths/~1v1~1dkim~1keys/get/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/dkim/keys","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/GET-v1-dkim-keys-multipart-form-data-RequestBody"}},"responseCodes":["200","401"],"pointer":"/v1/dkim/keys","href":"domain-keys/get-v1-dkim-keys","openApiOperationId":"GET-v1-dkim-keys","summary":"List keys for all domains"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/GET-v1-dkim-keys-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/GET-v1-dkim-keys-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-DomainKeyListResponse","exampleIds":["paths/~1v1~1dkim~1keys/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-DomainKeyListResponse","exampleIds":["paths/~1v1~1dkim~1keys/get/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim~1keys/get/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim~1keys/get/responses/401/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1dkim~1keys/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-DomainKeyListResponse","exampleIds":["paths/~1v1~1dkim~1keys/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-DomainKeyListResponse","exampleIds":["paths/~1v1~1dkim~1keys/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim~1keys/get/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim~1keys/get/responses/401/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-keys/get-v1-dkim-keys"}],"panels":[]}]},"httpPath":"/v1/dkim/keys"},{"label":"Create a domain key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-keys/post-v1-dkim-keys","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-keys/post-v1-dkim-keys","metadata":{"seo":{"title":"Create a domain key","description":"Create a domain key. Note that once private keys are created or imported they are never exported.Alternatively, you can import an existing PEM file containing a RSA private key in PKCS #1, ASn.1 DERformat. Note, the pem can be passed as a file attachment or as a form-string parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v1-dkim-keys","name":"Create a domain key","isWebhook":false,"pointer":"/paths/~1v1~1dkim~1keys/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a domain key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a domain key. Note that once private keys are created or imported they are never exported."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternatively, you can import an existing PEM file containing a RSA private key in PKCS #1, ASn.1 DER"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"format. Note, the pem can be passed as a file attachment or as a form-string parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v1-dkim-keys-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/POST-v1-dkim-keys-multipart-form-data-RequestBody","pointer":"/paths/~1v1~1dkim~1keys/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/dkim/keys","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/POST-v1-dkim-keys-multipart-form-data-RequestBody"}},"responseCodes":["200","401"],"pointer":"/v1/dkim/keys","href":"domain-keys/post-v1-dkim-keys","openApiOperationId":"POST-v1-dkim-keys","summary":"Create a domain key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/POST-v1-dkim-keys-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v1-dkim-keys-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-DomainKeyResponse","exampleIds":["paths/~1v1~1dkim~1keys/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-DomainKeyResponse","exampleIds":["paths/~1v1~1dkim~1keys/post/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim~1keys/post/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim~1keys/post/responses/401/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1dkim~1keys/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-DomainKeyResponse","exampleIds":["paths/~1v1~1dkim~1keys/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-DomainKeyResponse","exampleIds":["paths/~1v1~1dkim~1keys/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim~1keys/post/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim~1keys/post/responses/401/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-keys/post-v1-dkim-keys"}],"panels":[]}]},"httpPath":"/v1/dkim/keys"},{"label":"Delete a domain key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-keys/delete-v1-dkim-keys","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-keys/delete-v1-dkim-keys","metadata":{"seo":{"title":"Delete a domain key","description":"Domain keys are not recoverable after deletion so use with care"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v1-dkim-keys","name":"Delete a domain key","isWebhook":false,"pointer":"/paths/~1v1~1dkim~1keys/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a domain key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Domain keys are not recoverable after deletion so use with care"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"signing_domain","in":"query","schemaId":"components/schemas/string","description":"Signing Domain","required":true},{"name":"selector","in":"query","schemaId":"components/schemas/string","description":"Selector","required":true}],"pointer":"/paths/~1v1~1dkim~1keys/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/dkim/keys","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"signing_domain","in":"query","required":true,"schemaId":"components/schemas/string"},{"name":"selector","in":"query","required":true,"schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v1/dkim/keys","href":"domain-keys/delete-v1-dkim-keys","openApiOperationId":"DELETE-v1-dkim-keys","summary":"Delete a domain key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim~1keys/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim~1keys/delete/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim~1keys/delete/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim~1keys/delete/responses/400/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim~1keys/delete/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim~1keys/delete/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim~1keys/delete/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim~1keys/delete/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1dkim~1keys/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim~1keys/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim~1keys/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim~1keys/delete/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim~1keys/delete/responses/400/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim~1keys/delete/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim~1keys/delete/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim~1keys/delete/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim~1keys/delete/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-keys/delete-v1-dkim-keys"}],"panels":[]}]},"httpPath":"/v1/dkim/keys"},{"label":"Activate a domain key","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-keys/put-v4-domains--authority-name--keys--selector--activate","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-keys/put-v4-domains--authority-name--keys--selector--activate","metadata":{"seo":{"title":"Activate a domain key","description":"Activate a key to be used to DKIM sign emails with. Note: dns records must be valid for a domain key to be activated"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v4-domains--authority-name--keys--selector--activate","name":"Activate a domain key","isWebhook":false,"pointer":"/paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1activate/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activate a domain key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Activate a key to be used to DKIM sign emails with. Note: dns records must be valid for a domain key to be activated"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"authority_name","in":"path","schemaId":"components/schemas/string","description":"The domain authority name you want to activate. Must be a valid domain","required":true},{"name":"selector","in":"path","schemaId":"components/schemas/string","description":"The selector you want to activate for the domain key. Must be a valid dot atom","required":true}],"pointer":"/paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1activate/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v4/domains/{authority_name}/keys/{selector}/activate","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"authority_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"selector","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v4/domains/{authority_name}/keys/{selector}/activate","href":"domain-keys/put-v4-domains--authority-name--keys--selector--activate","openApiOperationId":"PUT-v4-domains--authority-name--keys--selector--activate","summary":"Activate a domain key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainKeyResp","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1activate/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainKeyResp","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1activate/put/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1activate/put/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1activate/put/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1activate/put/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1activate/put/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1activate/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainKeyResp","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1activate/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainKeyResp","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1activate/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1activate/put/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1activate/put/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1activate/put/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1activate/put/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-keys/put-v4-domains--authority-name--keys--selector--activate"}],"panels":[]}]},"httpPath":"/v4/domains/{authority_name}/keys/{selector}/activate"},{"label":"List domain keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-keys/get-v4-domains--authority-name--keys","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-keys/get-v4-domains--authority-name--keys","metadata":{"seo":{"title":"List domain keys","description":"List all domain keys for your domain, including active/inactive and valid/invalid ones."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v4-domains--authority-name--keys","name":"List domain keys","isWebhook":false,"pointer":"/paths/~1v4~1domains~1{authority_name}~1keys/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List domain keys","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all domain keys for your domain, including active/inactive and valid/invalid ones."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"authority_name","in":"path","schemaId":"components/schemas/string","description":"The domain authority name you want to list the domain keys for. Must be a valid domain","required":true}],"pointer":"/paths/~1v4~1domains~1{authority_name}~1keys/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/domains/{authority_name}/keys","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"authority_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v4/domains/{authority_name}/keys","href":"domain-keys/get-v4-domains--authority-name--keys","openApiOperationId":"GET-v4-domains--authority-name--keys","summary":"List domain keys"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-AuthorityKeysResponse","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-AuthorityKeysResponse","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys/get/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys/get/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys/get/responses/401/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v4~1domains~1{authority_name}~1keys/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-AuthorityKeysResponse","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-AuthorityKeysResponse","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys/get/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys/get/responses/401/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-keys/get-v4-domains--authority-name--keys"}],"panels":[]}]},"httpPath":"/v4/domains/{authority_name}/keys"},{"label":"Deactivate a domain key","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-keys/put-v4-domains--authority-name--keys--selector--deactivate","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-keys/put-v4-domains--authority-name--keys--selector--deactivate","metadata":{"seo":{"title":"Deactivate a domain key","description":"Deactivating for a specified authority and/or selector means a key won't be used for signing email anymore, even if they are valid."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v4-domains--authority-name--keys--selector--deactivate","name":"Deactivate a domain key","isWebhook":false,"pointer":"/paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1deactivate/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deactivate a domain key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deactivating for a specified authority and/or selector means a key won't be used for signing email anymore, even if they are valid."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"authority_name","in":"path","schemaId":"components/schemas/string","description":"The domain authority name you want to deactivate. Must be a valid domain","required":true},{"name":"selector","in":"path","schemaId":"components/schemas/string","description":"The selector you want to deactivate for the domain key. Must be a valid dot atom","required":true}],"pointer":"/paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1deactivate/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v4/domains/{authority_name}/keys/{selector}/deactivate","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"authority_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"selector","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v4/domains/{authority_name}/keys/{selector}/deactivate","href":"domain-keys/put-v4-domains--authority-name--keys--selector--deactivate","openApiOperationId":"PUT-v4-domains--authority-name--keys--selector--deactivate","summary":"Deactivate a domain key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainKeyResp","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1deactivate/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainKeyResp","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1deactivate/put/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1deactivate/put/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1deactivate/put/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1deactivate/put/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1deactivate/put/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1deactivate/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainKeyResp","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1deactivate/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainKeyResp","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1deactivate/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1deactivate/put/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1deactivate/put/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1deactivate/put/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1deactivate/put/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-keys/put-v4-domains--authority-name--keys--selector--deactivate"}],"panels":[]}]},"httpPath":"/v4/domains/{authority_name}/keys/{selector}/deactivate"},{"label":"Update DKIM authority","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-keys/put-v3-domains--name--dkim-authority","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-keys/put-v3-domains--name--dkim-authority","metadata":{"seo":{"title":"Update DKIM authority","description":"You can delegate the domain authority to an other domain. Domain's authority is set to itself by default."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v3-domains--name--dkim-authority","name":"Update DKIM authority","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{name}~1dkim_authority/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update DKIM authority","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can delegate the domain authority to an other domain. Domain's authority is set to itself by default."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"The domain name","required":true}],"pointer":"/paths/~1v3~1domains~1{name}~1dkim_authority/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domains-name-dkim_authority-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/PUT-v3-domains-name-dkim_authority-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1domains~1{name}~1dkim_authority/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/domains/{name}/dkim_authority","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domains-name-dkim_authority-multipart-form-data-RequestBody"}},"responseCodes":["200","401","404"],"pointer":"/v3/domains/{name}/dkim_authority","href":"domain-keys/put-v3-domains--name--dkim-authority","openApiOperationId":"PUT-v3-domains--name--dkim-authority","summary":"Update DKIM authority"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/PUT-v3-domains-name-dkim_authority-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domains-name-dkim_authority-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-ReassignDkimAuthorityResp"}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-ReassignDkimAuthorityResp"},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dkim_authority/put/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dkim_authority/put/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dkim_authority/put/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dkim_authority/put/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{name}~1dkim_authority/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-ReassignDkimAuthorityResp","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-ReassignDkimAuthorityResp"}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dkim_authority/put/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dkim_authority/put/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dkim_authority/put/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dkim_authority/put/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-keys/put-v3-domains--name--dkim-authority"}],"panels":[]}]},"httpPath":"/v3/domains/{name}/dkim_authority"},{"label":"Update a DKIM selector","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-keys/put-v3-domains--name--dkim-selector","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-keys/put-v3-domains--name--dkim-selector","metadata":{"seo":{"title":"Update a DKIM selector","description":"Selector is the unique identifier of your key. It has to be different from other keys selector."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v3-domains--name--dkim-selector","name":"Update a DKIM selector","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{name}~1dkim_selector/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a DKIM selector","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Selector is the unique identifier of your key. It has to be different from other keys selector."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"The domain name","required":true}],"pointer":"/paths/~1v3~1domains~1{name}~1dkim_selector/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domains-name-dkim_selector-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/PUT-v3-domains-name-dkim_selector-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1domains~1{name}~1dkim_selector/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/domains/{name}/dkim_selector","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domains-name-dkim_selector-multipart-form-data-RequestBody"}},"responseCodes":["200","401","404"],"pointer":"/v3/domains/{name}/dkim_selector","href":"domain-keys/put-v3-domains--name--dkim-selector","openApiOperationId":"PUT-v3-domains--name--dkim-selector","summary":"Update a DKIM selector"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/PUT-v3-domains-name-dkim_selector-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domains-name-dkim_selector-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dkim_selector/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dkim_selector/put/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dkim_selector/put/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dkim_selector/put/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dkim_selector/put/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dkim_selector/put/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{name}~1dkim_selector/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dkim_selector/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dkim_selector/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dkim_selector/put/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dkim_selector/put/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dkim_selector/put/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dkim_selector/put/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-keys/put-v3-domains--name--dkim-selector"}],"panels":[]}]},"httpPath":"/v3/domains/{name}/dkim_selector"}],"content":{"contentType":"group","meta":{"name":"Domain Keys"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Domain Keys","showPageActions":true},{"nodeType":"markdoc","content":"An authentication standard used to prevent email spoofing."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/dkim/keys","summary":"List keys for all domains","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain-keys/get-v1-dkim-keys","deprecated":false},{"title":"/v1/dkim/keys","summary":"Create a domain key","prefix":{"name":"post","color":"post"},"badges":[],"link":"/domain-keys/post-v1-dkim-keys","deprecated":false},{"title":"/v1/dkim/keys","summary":"Delete a domain key","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/domain-keys/delete-v1-dkim-keys","deprecated":false},{"title":"/v4/domains/{authority_name}/keys/{selector}/activate","summary":"Activate a domain key","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain-keys/put-v4-domains--authority-name--keys--selector--activate","deprecated":false},{"title":"/v4/domains/{authority_name}/keys","summary":"List domain keys","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain-keys/get-v4-domains--authority-name--keys","deprecated":false},{"title":"/v4/domains/{authority_name}/keys/{selector}/deactivate","summary":"Deactivate a domain key","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain-keys/put-v4-domains--authority-name--keys--selector--deactivate","deprecated":false},{"title":"/v3/domains/{name}/dkim_authority","summary":"Update DKIM authority","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain-keys/put-v3-domains--name--dkim-authority","deprecated":false},{"title":"/v3/domains/{name}/dkim_selector","summary":"Update a DKIM selector","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain-keys/put-v3-domains--name--dkim-selector","deprecated":false}]}]}]}]}},{"type":"group","label":"Domain Tracking","link":"/docs/mailgun/api-reference/send/mailgun/domain-tracking","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-tracking","items":[{"label":"Get tracking settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-tracking/get-v3-domains--name--tracking","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-tracking/get-v3-domains--name--tracking","metadata":{"seo":{"title":"Get tracking settings","description":"Use to check if open, click and unsubscribe tracking are active/inactive."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-domains--name--tracking","name":"Get tracking settings","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{name}~1tracking/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get tracking settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use to check if open, click and unsubscribe tracking are active/inactive."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"The name of the domain to fetch tracking details for.","required":true}],"pointer":"/paths/~1v3~1domains~1{name}~1tracking/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/domains/{name}/tracking","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/domains/{name}/tracking","href":"domain-tracking/get-v3-domains--name--tracking","openApiOperationId":"GET-v3-domains--name--tracking","summary":"Get tracking settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetDomainTrackingResp","exampleIds":["paths/~1v3~1domains~1{name}~1tracking/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetDomainTrackingResp","exampleIds":["paths/~1v3~1domains~1{name}~1tracking/get/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking/get/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking/get/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking/get/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking/get/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{name}~1tracking/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetDomainTrackingResp","exampleIds":["paths/~1v3~1domains~1{name}~1tracking/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetDomainTrackingResp","exampleIds":["paths/~1v3~1domains~1{name}~1tracking/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking/get/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking/get/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking/get/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking/get/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-tracking/get-v3-domains--name--tracking"}],"panels":[]}]},"httpPath":"/v3/domains/{name}/tracking"},{"label":"Update click tracking settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-tracking/put-v3-domains--name--tracking-click","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-tracking/put-v3-domains--name--tracking-click","metadata":{"seo":{"title":"Update click tracking settings","description":"Use to turn on/off the click tracking at the domain level."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v3-domains--name--tracking-click","name":"Update click tracking settings","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{name}~1tracking~1click/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update click tracking settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use to turn on/off the click tracking at the domain level."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"The name of the domain you want to update","required":true}],"pointer":"/paths/~1v3~1domains~1{name}~1tracking~1click/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domains-name-tracking-click-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/PUT-v3-domains-name-tracking-click-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1domains~1{name}~1tracking~1click/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/domains/{name}/tracking/click","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domains-name-tracking-click-multipart-form-data-RequestBody"}},"responseCodes":["200","401","404"],"pointer":"/v3/domains/{name}/tracking/click","href":"domain-tracking/put-v3-domains--name--tracking-click","openApiOperationId":"PUT-v3-domains--name--tracking-click","summary":"Update click tracking settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/PUT-v3-domains-name-tracking-click-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domains-name-tracking-click-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainTrackingClickResp","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1click/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainTrackingClickResp","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1click/put/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1click/put/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1click/put/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1click/put/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1click/put/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{name}~1tracking~1click/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainTrackingClickResp","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1click/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainTrackingClickResp","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1click/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1click/put/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1click/put/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1click/put/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1click/put/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-tracking/put-v3-domains--name--tracking-click"}],"panels":[]}]},"httpPath":"/v3/domains/{name}/tracking/click"},{"label":"Update open tracking settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-tracking/put-v3-domains--name--tracking-open","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-tracking/put-v3-domains--name--tracking-open","metadata":{"seo":{"title":"Update open tracking settings","description":"Use to turn on/off the open tracking at the domain level."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v3-domains--name--tracking-open","name":"Update open tracking settings","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{name}~1tracking~1open/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update open tracking settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use to turn on/off the open tracking at the domain level."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"The name of the domain you want to update","required":true}],"pointer":"/paths/~1v3~1domains~1{name}~1tracking~1open/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domains-name-tracking-open-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/PUT-v3-domains-name-tracking-open-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1domains~1{name}~1tracking~1open/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/domains/{name}/tracking/open","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domains-name-tracking-open-multipart-form-data-RequestBody"}},"responseCodes":["200","401","404"],"pointer":"/v3/domains/{name}/tracking/open","href":"domain-tracking/put-v3-domains--name--tracking-open","openApiOperationId":"PUT-v3-domains--name--tracking-open","summary":"Update open tracking settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/PUT-v3-domains-name-tracking-open-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domains-name-tracking-open-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainTrackingOpenResp","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1open/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainTrackingOpenResp","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1open/put/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1open/put/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1open/put/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1open/put/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1open/put/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{name}~1tracking~1open/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainTrackingOpenResp","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1open/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainTrackingOpenResp","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1open/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1open/put/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1open/put/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1open/put/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1open/put/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-tracking/put-v3-domains--name--tracking-open"}],"panels":[]}]},"httpPath":"/v3/domains/{name}/tracking/open"},{"label":"Update unsubscribe tracking settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-tracking/put-v3-domains--name--tracking-unsubscribe","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-tracking/put-v3-domains--name--tracking-unsubscribe","metadata":{"seo":{"title":"Update unsubscribe tracking settings","description":"Use to turn on/off the unsubscribe tracking at the domain level."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v3-domains--name--tracking-unsubscribe","name":"Update unsubscribe tracking settings","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{name}~1tracking~1unsubscribe/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update unsubscribe tracking settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use to turn on/off the unsubscribe tracking at the domain level."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"The name of the domain you want to update","required":true}],"pointer":"/paths/~1v3~1domains~1{name}~1tracking~1unsubscribe/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domains-name-tracking-unsubscribe-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/PUT-v3-domains-name-tracking-unsubscribe-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1domains~1{name}~1tracking~1unsubscribe/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/domains/{name}/tracking/unsubscribe","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domains-name-tracking-unsubscribe-multipart-form-data-RequestBody"}},"responseCodes":["200","401","404"],"pointer":"/v3/domains/{name}/tracking/unsubscribe","href":"domain-tracking/put-v3-domains--name--tracking-unsubscribe","openApiOperationId":"PUT-v3-domains--name--tracking-unsubscribe","summary":"Update unsubscribe tracking settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/PUT-v3-domains-name-tracking-unsubscribe-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domains-name-tracking-unsubscribe-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainTrackingUnsubscribeResp","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1unsubscribe/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainTrackingUnsubscribeResp","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1unsubscribe/put/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1unsubscribe/put/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1unsubscribe/put/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1unsubscribe/put/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1unsubscribe/put/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{name}~1tracking~1unsubscribe/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainTrackingUnsubscribeResp","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1unsubscribe/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainTrackingUnsubscribeResp","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1unsubscribe/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1unsubscribe/put/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1unsubscribe/put/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1unsubscribe/put/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1tracking~1unsubscribe/put/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-tracking/put-v3-domains--name--tracking-unsubscribe"}],"panels":[]}]},"httpPath":"/v3/domains/{name}/tracking/unsubscribe"},{"label":"Tracking Certificate: Get certificate and status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-tracking/get-v2-x509--domain--status","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-tracking/get-v2-x509--domain--status","metadata":{"seo":{"title":"Tracking Certificate: Get certificate and status","description":"Get x509 TLS certificate and status"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v2-x509--domain--status","name":"Tracking Certificate: Get certificate and status","isWebhook":false,"pointer":"/paths/~1v2~1x509~1{domain}~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tracking Certificate: Get certificate and status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get x509 TLS certificate and status"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tracking domain of the TLS certificate, formatted as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"web_prefix.domain_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"web_prefix"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is configured in your domains settings)"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v2~1x509~1{domain}~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/x509/{domain}/status","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/x509/{domain}/status","href":"domain-tracking/get-v2-x509--domain--status","openApiOperationId":"GET-v2-x509--domain--status","summary":"Tracking Certificate: Get certificate and status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-terminator-httpapi-StatusResponse","exampleIds":["paths/~1v2~1x509~1{domain}~1status/get/responses/200/content/application~1json/examples/Processing","paths/~1v2~1x509~1{domain}~1status/get/responses/200/content/application~1json/examples/Active","paths/~1v2~1x509~1{domain}~1status/get/responses/200/content/application~1json/examples/Expired","paths/~1v2~1x509~1{domain}~1status/get/responses/200/content/application~1json/examples/Error"]}},"schemaId":"components/schemas/github.com-mailgun-terminator-httpapi-StatusResponse","exampleIds":["paths/~1v2~1x509~1{domain}~1status/get/responses/200/content/application~1json/examples/Processing","paths/~1v2~1x509~1{domain}~1status/get/responses/200/content/application~1json/examples/Active","paths/~1v2~1x509~1{domain}~1status/get/responses/200/content/application~1json/examples/Expired","paths/~1v2~1x509~1{domain}~1status/get/responses/200/content/application~1json/examples/Error"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v2~1x509~1{domain}~1status/get/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v2~1x509~1{domain}~1status/get/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v2~1x509~1{domain}~1status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-terminator-httpapi-StatusResponse","exampleIds":["paths/~1v2~1x509~1{domain}~1status/get/responses/200/content/application~1json/examples/Processing","paths/~1v2~1x509~1{domain}~1status/get/responses/200/content/application~1json/examples/Active","paths/~1v2~1x509~1{domain}~1status/get/responses/200/content/application~1json/examples/Expired","paths/~1v2~1x509~1{domain}~1status/get/responses/200/content/application~1json/examples/Error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-terminator-httpapi-StatusResponse","exampleIds":["paths/~1v2~1x509~1{domain}~1status/get/responses/200/content/application~1json/examples/Processing","paths/~1v2~1x509~1{domain}~1status/get/responses/200/content/application~1json/examples/Active","paths/~1v2~1x509~1{domain}~1status/get/responses/200/content/application~1json/examples/Expired","paths/~1v2~1x509~1{domain}~1status/get/responses/200/content/application~1json/examples/Error"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v2~1x509~1{domain}~1status/get/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v2~1x509~1{domain}~1status/get/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-tracking/get-v2-x509--domain--status"}],"panels":[]}]},"httpPath":"/v2/x509/{domain}/status"},{"label":"Tracking Certificate: Regenerate expired certificate","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-tracking/put-v2-x509--domain-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-tracking/put-v2-x509--domain-","metadata":{"seo":{"title":"Tracking Certificate: Regenerate expired certificate","description":"Initiates regeneration of an expired TLS certificate for the tracking domain in a background task. Once generation is enqueued, you may poll status endpoint in location field to check for success. This will not regenerate an existing certificate that is still valid"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v2-x509--domain-","name":"Tracking Certificate: Regenerate expired certificate","isWebhook":false,"pointer":"/paths/~1v2~1x509~1{domain}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tracking Certificate: Regenerate expired certificate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Initiates regeneration of an expired TLS certificate for the tracking domain in a background task.  Once generation is enqueued, you may poll status endpoint in location field to check for success.  This will not regenerate an existing certificate that is still valid"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"components/schemas/string","description":"The tracking domain of the TLS certificate, formatted as webPrefix.domainName from domains settings","required":true}],"pointer":"/paths/~1v2~1x509~1{domain}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/x509/{domain}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["202","400","402","404","409","429"],"pointer":"/v2/x509/{domain}","href":"domain-tracking/put-v2-x509--domain-","openApiOperationId":"PUT-v2-x509--domain-","summary":"Tracking Certificate: Regenerate expired certificate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"A 202 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-terminator-httpapi-GenerateResponse","exampleIds":["paths/~1v2~1x509~1{domain}/put/responses/202/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-terminator-httpapi-GenerateResponse","exampleIds":["paths/~1v2~1x509~1{domain}/put/responses/202/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError","exampleIds":["paths/~1v2~1x509~1{domain}/put/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError","exampleIds":["paths/~1v2~1x509~1{domain}/put/responses/400/content/application~1json/examples/Example"]},{"code":"402","description":"A 402 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError","exampleIds":["paths/~1v2~1x509~1{domain}/put/responses/402/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError","exampleIds":["paths/~1v2~1x509~1{domain}/put/responses/402/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v2~1x509~1{domain}/put/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v2~1x509~1{domain}/put/responses/404/content/application~1json/examples/Example"]},{"code":"409","description":"A 409 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v2~1x509~1{domain}/put/responses/409/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v2~1x509~1{domain}/put/responses/409/content/application~1json/examples/Example"]},{"code":"429","description":"A 429 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v2~1x509~1{domain}/put/responses/429/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v2~1x509~1{domain}/put/responses/429/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v2~1x509~1{domain}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/github.com-mailgun-terminator-httpapi-GenerateResponse","exampleIds":["paths/~1v2~1x509~1{domain}/put/responses/202/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-terminator-httpapi-GenerateResponse","exampleIds":["paths/~1v2~1x509~1{domain}/put/responses/202/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError","exampleIds":["paths/~1v2~1x509~1{domain}/put/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError","exampleIds":["paths/~1v2~1x509~1{domain}/put/responses/400/content/application~1json/examples/Example"]}}},{"code":"402","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError","exampleIds":["paths/~1v2~1x509~1{domain}/put/responses/402/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError","exampleIds":["paths/~1v2~1x509~1{domain}/put/responses/402/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v2~1x509~1{domain}/put/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v2~1x509~1{domain}/put/responses/404/content/application~1json/examples/Example"]}}},{"code":"409","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v2~1x509~1{domain}/put/responses/409/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v2~1x509~1{domain}/put/responses/409/content/application~1json/examples/Example"]}}},{"code":"429","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v2~1x509~1{domain}/put/responses/429/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v2~1x509~1{domain}/put/responses/429/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-tracking/put-v2-x509--domain-"}],"panels":[]}]},"httpPath":"/v2/x509/{domain}"},{"label":"Tracking Certificate: Generate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-tracking/post-v2-x509--domain-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-tracking/post-v2-x509--domain-","metadata":{"seo":{"title":"Tracking Certificate: Generate","description":"Initiates generation of a TLS certificate for the tracking domain in a background task.  Once generation is enqueued, you may poll the status endpoint in location field to check for success"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v2-x509--domain-","name":"Tracking Certificate: Generate","isWebhook":false,"pointer":"/paths/~1v2~1x509~1{domain}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tracking Certificate: Generate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates generation of a TLS certificate for the tracking domain in a background task.  Once generation is enqueued, you may poll the status endpoint in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to check for success"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"components/schemas/string","description":"The tracking domain of the TLS certificate, formatted as webPrefix.domainName from domains settings","required":true}],"pointer":"/paths/~1v2~1x509~1{domain}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/x509/{domain}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["202","400","402","404","409"],"pointer":"/v2/x509/{domain}","href":"domain-tracking/post-v2-x509--domain-","openApiOperationId":"POST-v2-x509--domain-","summary":"Tracking Certificate: Generate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"A 202 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-terminator-httpapi-GenerateResponse","exampleIds":["paths/~1v2~1x509~1{domain}/post/responses/202/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-terminator-httpapi-GenerateResponse","exampleIds":["paths/~1v2~1x509~1{domain}/post/responses/202/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError","exampleIds":["paths/~1v2~1x509~1{domain}/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError","exampleIds":["paths/~1v2~1x509~1{domain}/post/responses/400/content/application~1json/examples/Example"]},{"code":"402","description":"A 402 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError","exampleIds":["paths/~1v2~1x509~1{domain}/post/responses/402/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError","exampleIds":["paths/~1v2~1x509~1{domain}/post/responses/402/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v2~1x509~1{domain}/post/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v2~1x509~1{domain}/post/responses/404/content/application~1json/examples/Example"]},{"code":"409","description":"A 409 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v2~1x509~1{domain}/post/responses/409/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v2~1x509~1{domain}/post/responses/409/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v2~1x509~1{domain}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/github.com-mailgun-terminator-httpapi-GenerateResponse","exampleIds":["paths/~1v2~1x509~1{domain}/post/responses/202/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-terminator-httpapi-GenerateResponse","exampleIds":["paths/~1v2~1x509~1{domain}/post/responses/202/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError","exampleIds":["paths/~1v2~1x509~1{domain}/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError","exampleIds":["paths/~1v2~1x509~1{domain}/post/responses/400/content/application~1json/examples/Example"]}}},{"code":"402","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError","exampleIds":["paths/~1v2~1x509~1{domain}/post/responses/402/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError","exampleIds":["paths/~1v2~1x509~1{domain}/post/responses/402/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v2~1x509~1{domain}/post/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v2~1x509~1{domain}/post/responses/404/content/application~1json/examples/Example"]}}},{"code":"409","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v2~1x509~1{domain}/post/responses/409/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v2~1x509~1{domain}/post/responses/409/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-tracking/post-v2-x509--domain-"}],"panels":[]}]},"httpPath":"/v2/x509/{domain}"}],"content":{"contentType":"group","meta":{"name":"Domain Tracking"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Domain Tracking","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mailgun offers tracking for clicks, unsubscribes, and opens, with optional HTTPS protocol support on tracking URLs. To enable HTTPS, Mailgun uses Let’s Encrypt with HTTP-01 challenges through your existing tracking CNAME record to issue a TLS certificate. This setup also includes support for HTTP Strict Transport Security (HSTS) for enhanced security."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/domains/{name}/tracking","summary":"Get tracking settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain-tracking/get-v3-domains--name--tracking","deprecated":false},{"title":"/v3/domains/{name}/tracking/click","summary":"Update click tracking settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain-tracking/put-v3-domains--name--tracking-click","deprecated":false},{"title":"/v3/domains/{name}/tracking/open","summary":"Update open tracking settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain-tracking/put-v3-domains--name--tracking-open","deprecated":false},{"title":"/v3/domains/{name}/tracking/unsubscribe","summary":"Update unsubscribe tracking settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain-tracking/put-v3-domains--name--tracking-unsubscribe","deprecated":false},{"title":"/v2/x509/{domain}/status","summary":"Tracking Certificate: Get certificate and status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain-tracking/get-v2-x509--domain--status","deprecated":false},{"title":"/v2/x509/{domain}","summary":"Tracking Certificate: Regenerate expired certificate","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain-tracking/put-v2-x509--domain-","deprecated":false},{"title":"/v2/x509/{domain}","summary":"Tracking Certificate: Generate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/domain-tracking/post-v2-x509--domain-","deprecated":false}]}]}]}]}},{"type":"group","label":"DKIM Security","link":"/docs/mailgun/api-reference/send/mailgun/dkim-security","routeSlug":"/docs/mailgun/api-reference/send/mailgun/dkim-security","items":[{"label":"Update Automatic Sender Security DKIM key rotation for a domain","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/dkim-security/put-v1-dkim-management-domains--name--rotation","routeSlug":"/docs/mailgun/api-reference/send/mailgun/dkim-security/put-v1-dkim-management-domains--name--rotation","metadata":{"seo":{"title":"Update Automatic Sender Security DKIM key rotation for a domain","description":"The minimum allowed interval for rotation is 5 days."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v1-dkim-management-domains--name--rotation","name":"Update Automatic Sender Security DKIM key rotation for a domain","isWebhook":false,"pointer":"/paths/~1v1~1dkim_management~1domains~1{name}~1rotation/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Automatic Sender Security DKIM key rotation for a domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The minimum allowed interval for rotation is 5 days."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"The Domain name","required":true}],"pointer":"/paths/~1v1~1dkim_management~1domains~1{name}~1rotation/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v1-dkim_management-domains-name-rotation-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/PUT-v1-dkim_management-domains-name-rotation-multipart-form-data-RequestBody","pointer":"/paths/~1v1~1dkim_management~1domains~1{name}~1rotation/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/dkim_management/domains/{name}/rotation","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v1-dkim_management-domains-name-rotation-multipart-form-data-RequestBody"}},"responseCodes":["200","400","404"],"pointer":"/v1/dkim_management/domains/{name}/rotation","href":"dkim-security/put-v1-dkim-management-domains--name--rotation","openApiOperationId":"PUT-v1-dkim-management-domains--name--rotation","summary":"Update Automatic Sender Security DKIM key rotation for a domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/PUT-v1-dkim_management-domains-name-rotation-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v1-dkim_management-domains-name-rotation-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-pendulum-api-DomainResponse","exampleIds":["paths/~1v1~1dkim_management~1domains~1{name}~1rotation/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-pendulum-api-DomainResponse","exampleIds":["paths/~1v1~1dkim_management~1domains~1{name}~1rotation/put/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError","exampleIds":["paths/~1v1~1dkim_management~1domains~1{name}~1rotation/put/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError","exampleIds":["paths/~1v1~1dkim_management~1domains~1{name}~1rotation/put/responses/400/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v1~1dkim_management~1domains~1{name}~1rotation/put/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v1~1dkim_management~1domains~1{name}~1rotation/put/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1dkim_management~1domains~1{name}~1rotation/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-pendulum-api-DomainResponse","exampleIds":["paths/~1v1~1dkim_management~1domains~1{name}~1rotation/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-pendulum-api-DomainResponse","exampleIds":["paths/~1v1~1dkim_management~1domains~1{name}~1rotation/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError","exampleIds":["paths/~1v1~1dkim_management~1domains~1{name}~1rotation/put/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError","exampleIds":["paths/~1v1~1dkim_management~1domains~1{name}~1rotation/put/responses/400/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v1~1dkim_management~1domains~1{name}~1rotation/put/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v1~1dkim_management~1domains~1{name}~1rotation/put/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dkim-security/put-v1-dkim-management-domains--name--rotation"}],"panels":[]}]},"httpPath":"/v1/dkim_management/domains/{name}/rotation"},{"label":"Rotate Automatic Sender Security DKIM key for a domain","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/dkim-security/post-v1-dkim-management-domains--name--rotate","routeSlug":"/docs/mailgun/api-reference/send/mailgun/dkim-security/post-v1-dkim-management-domains--name--rotate","metadata":{"seo":{"title":"Rotate Automatic Sender Security DKIM key for a domain","description":"Immediately rotate your DKIM key. This will trigger a rotation even if auto-rotation is disabled on the domain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v1-dkim-management-domains--name--rotate","name":"Rotate Automatic Sender Security DKIM key for a domain","isWebhook":false,"pointer":"/paths/~1v1~1dkim_management~1domains~1{name}~1rotate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rotate Automatic Sender Security DKIM key for a domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Immediately rotate your DKIM key. This will trigger a rotation even if auto-rotation is disabled on the domain."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"The Domain name","required":true}],"pointer":"/paths/~1v1~1dkim_management~1domains~1{name}~1rotate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/dkim_management/domains/{name}/rotate","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/v1/dkim_management/domains/{name}/rotate","href":"dkim-security/post-v1-dkim-management-domains--name--rotate","openApiOperationId":"POST-v1-dkim-management-domains--name--rotate","summary":"Rotate Automatic Sender Security DKIM key for a domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim_management~1domains~1{name}~1rotate/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim_management~1domains~1{name}~1rotate/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError","exampleIds":["paths/~1v1~1dkim_management~1domains~1{name}~1rotate/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError","exampleIds":["paths/~1v1~1dkim_management~1domains~1{name}~1rotate/post/responses/400/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v1~1dkim_management~1domains~1{name}~1rotate/post/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v1~1dkim_management~1domains~1{name}~1rotate/post/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1dkim_management~1domains~1{name}~1rotate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim_management~1domains~1{name}~1rotate/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dkim_management~1domains~1{name}~1rotate/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError","exampleIds":["paths/~1v1~1dkim_management~1domains~1{name}~1rotate/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError","exampleIds":["paths/~1v1~1dkim_management~1domains~1{name}~1rotate/post/responses/400/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v1~1dkim_management~1domains~1{name}~1rotate/post/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","exampleIds":["paths/~1v1~1dkim_management~1domains~1{name}~1rotate/post/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dkim-security/post-v1-dkim-management-domains--name--rotate"}],"panels":[]}]},"httpPath":"/v1/dkim_management/domains/{name}/rotate"}],"content":{"contentType":"group","meta":{"name":"DKIM Security"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DKIM Security","showPageActions":true},{"nodeType":"markdoc","content":"Automatic Sender Security DKIM Key APIs. To enable this feature please see 'Update a domain' API docs."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/dkim_management/domains/{name}/rotation","summary":"Update Automatic Sender Security DKIM key rotation for a domain","prefix":{"name":"put","color":"put"},"badges":[],"link":"/dkim-security/put-v1-dkim-management-domains--name--rotation","deprecated":false},{"title":"/v1/dkim_management/domains/{name}/rotate","summary":"Rotate Automatic Sender Security DKIM key for a domain","prefix":{"name":"post","color":"post"},"badges":[],"link":"/dkim-security/post-v1-dkim-management-domains--name--rotate","deprecated":false}]}]}]}]}},{"type":"separator","label":"Webhooks","content":null},{"type":"group","label":"Account Webhooks","link":"/docs/mailgun/api-reference/send/mailgun/account-webhooks","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-webhooks","items":[{"label":"List account-level webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-webhooks/get-v1-webhooks","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-webhooks/get-v1-webhooks","metadata":{"seo":{"title":"List account-level webhooks","description":"Retrieve all account-level webhooks or filter by specific webhook IDs. Returns webhook details including associated event types."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-webhooks","name":"List account-level webhooks","isWebhook":false,"pointer":"/paths/~1v1~1webhooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List account-level webhooks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve all account-level webhooks or filter by specific webhook IDs. Returns webhook details including associated event types."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"webhook_ids","in":"query","schemaId":"components/schemas/string","description":"Comma-separated list of webhook IDs to filter results. If specified, only webhooks with matching IDs will be returned."}],"pointer":"/paths/~1v1~1webhooks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/webhooks","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"webhook_ids","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/v1/webhooks","href":"account-webhooks/get-v1-webhooks","openApiOperationId":"GET-v1-webhooks","summary":"List account-level webhooks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-AccountLevelWebhooksResp","exampleIds":["paths/~1v1~1webhooks/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-AccountLevelWebhooksResp","exampleIds":["paths/~1v1~1webhooks/get/responses/200/content/application~1json/examples/Example"]},{"code":"403","description":"A 403 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/get/responses/403/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/get/responses/403/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-AccountLevelWebhooksResp","exampleIds":["paths/~1v1~1webhooks/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-AccountLevelWebhooksResp","exampleIds":["paths/~1v1~1webhooks/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/get/responses/403/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/get/responses/403/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-webhooks/get-v1-webhooks"}],"panels":[]}]},"httpPath":"/v1/webhooks"},{"label":"Create an account-level webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-webhooks/post-v1-webhooks","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-webhooks/post-v1-webhooks","metadata":{"seo":{"title":"Create an account-level webhook","description":"Create account-level webhook URLs to receive Mailgun's POST requests containing event information across all domains in your account. Note: Webhook changes can take up to 10 minutes to become effective due to caching."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v1-webhooks","name":"Create an account-level webhook","isWebhook":false,"pointer":"/paths/~1v1~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an account-level webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create account-level webhook URLs to receive Mailgun's POST requests containing event information across all domains in your account. Note: Webhook changes can take up to 10 minutes to become effective due to caching."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v1-webhooks-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/POST-v1-webhooks-multipart-form-data-RequestBody","pointer":"/paths/~1v1~1webhooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhooks","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/POST-v1-webhooks-multipart-form-data-RequestBody"}},"responseCodes":["200","400","403","404","409"],"pointer":"/v1/webhooks","href":"account-webhooks/post-v1-webhooks","openApiOperationId":"POST-v1-webhooks","summary":"Create an account-level webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/POST-v1-webhooks-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v1-webhooks-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-CreateAccountLevelWebhookResp","exampleIds":["paths/~1v1~1webhooks/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-CreateAccountLevelWebhookResp","exampleIds":["paths/~1v1~1webhooks/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/post/responses/400/content/application~1json/examples/Example"]},{"code":"403","description":"A 403 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/post/responses/403/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/post/responses/403/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/post/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/post/responses/404/content/application~1json/examples/Example"]},{"code":"409","description":"A 409 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/post/responses/409/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/post/responses/409/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-CreateAccountLevelWebhookResp","exampleIds":["paths/~1v1~1webhooks/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-CreateAccountLevelWebhookResp","exampleIds":["paths/~1v1~1webhooks/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/post/responses/400/content/application~1json/examples/Example"]}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/post/responses/403/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/post/responses/403/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/post/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/post/responses/404/content/application~1json/examples/Example"]}}},{"code":"409","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/post/responses/409/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/post/responses/409/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-webhooks/post-v1-webhooks"}],"panels":[]}]},"httpPath":"/v1/webhooks"},{"label":"Delete account-level webhooks","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-webhooks/delete-v1-webhooks","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-webhooks/delete-v1-webhooks","metadata":{"seo":{"title":"Delete account-level webhooks","description":"Delete account-level webhooks for the authenticated account. You can either delete all webhooks by setting all=true, or specify specific webhook IDs to delete via webhook_ids. If both are provided, the specific webhook_ids will be deleted. Note: Webhook changes can take up to 10 minutes to become effective due to caching."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v1-webhooks","name":"Delete account-level webhooks","isWebhook":false,"pointer":"/paths/~1v1~1webhooks/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete account-level webhooks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete account-level webhooks for the authenticated account. You can either delete all webhooks by setting all=true, or specify specific webhook IDs to delete via webhook_ids. If both are provided, the specific webhook_ids will be deleted. Note: Webhook changes can take up to 10 minutes to become effective due to caching."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"webhook_ids","in":"query","schemaId":"components/schemas/string","description":"Comma-separated list of webhook IDs to delete. If provided, only these specific webhooks will be deleted."},{"name":"all","in":"query","schemaId":"schema_261","description":"Set to 'true' to delete all account-level webhooks. This acts as a safety mechanism to prevent accidental deletion of all webhooks."}],"pointer":"/paths/~1v1~1webhooks/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/webhooks","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"webhook_ids","in":"query","schemaId":"components/schemas/string"},{"name":"all","in":"query","schemaId":"schema_261"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","400","403","404"],"pointer":"/v1/webhooks","href":"account-webhooks/delete-v1-webhooks","openApiOperationId":"DELETE-v1-webhooks","summary":"Delete account-level webhooks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"A 204 response"},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/delete/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/delete/responses/400/content/application~1json/examples/Example"]},{"code":"403","description":"A 403 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/delete/responses/403/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/delete/responses/403/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/delete/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/delete/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1webhooks/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/delete/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/delete/responses/400/content/application~1json/examples/Example"]}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/delete/responses/403/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/delete/responses/403/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/delete/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks/delete/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-webhooks/delete-v1-webhooks"}],"panels":[]}]},"httpPath":"/v1/webhooks"},{"label":"Get account-level webhook by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-webhooks/get-v1-webhooks--webhook-id-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-webhooks/get-v1-webhooks--webhook-id-","metadata":{"seo":{"title":"Get account-level webhook by ID","description":"Retrieve a specific account-level webhook by its webhook ID. Returns webhook details including associated event types."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-webhooks--webhook-id-","name":"Get account-level webhook by ID","isWebhook":false,"pointer":"/paths/~1v1~1webhooks~1{webhook_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get account-level webhook by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specific account-level webhook by its webhook ID. Returns webhook details including associated event types."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhook_id","in":"path","schemaId":"components/schemas/string","description":"The webhook ID to retrieve","required":true}],"pointer":"/paths/~1v1~1webhooks~1{webhook_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/webhooks/{webhook_id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"webhook_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/v1/webhooks/{webhook_id}","href":"account-webhooks/get-v1-webhooks--webhook-id-","openApiOperationId":"GET-v1-webhooks--webhook-id-","summary":"Get account-level webhook by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-AccountLevelWebhookView","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-AccountLevelWebhookView","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/examples/Example"]},{"code":"403","description":"A 403 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/get/responses/403/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/get/responses/403/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/get/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/get/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1webhooks~1{webhook_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-AccountLevelWebhookView","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-AccountLevelWebhookView","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/get/responses/403/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/get/responses/403/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/get/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/get/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-webhooks/get-v1-webhooks--webhook-id-"}],"panels":[]}]},"httpPath":"/v1/webhooks/{webhook_id}"},{"label":"Update an account-level webhook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-webhooks/put-v1-webhooks--webhook-id-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-webhooks/put-v1-webhooks--webhook-id-","metadata":{"seo":{"title":"Update an account-level webhook","description":"Update an existing account-level webhook by replacing its URL, description, and event types. The webhook is identified by webhook_id and completely replaced with the new configuration. Note: Webhook changes can take up to 10 minutes to become effective due to caching."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v1-webhooks--webhook-id-","name":"Update an account-level webhook","isWebhook":false,"pointer":"/paths/~1v1~1webhooks~1{webhook_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an account-level webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update an existing account-level webhook by replacing its URL, description, and event types. The webhook is identified by webhook_id and completely replaced with the new configuration. Note: Webhook changes can take up to 10 minutes to become effective due to caching."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhook_id","in":"path","schemaId":"components/schemas/string","description":"The webhook ID to update","required":true}],"pointer":"/paths/~1v1~1webhooks~1{webhook_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v1-webhooks-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/POST-v1-webhooks-multipart-form-data-RequestBody","pointer":"/paths/~1v1~1webhooks~1{webhook_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/webhooks/{webhook_id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"webhook_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/POST-v1-webhooks-multipart-form-data-RequestBody"}},"responseCodes":["204","400","403","404","409"],"pointer":"/v1/webhooks/{webhook_id}","href":"account-webhooks/put-v1-webhooks--webhook-id-","openApiOperationId":"PUT-v1-webhooks--webhook-id-","summary":"Update an account-level webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/POST-v1-webhooks-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v1-webhooks-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"A 204 response"},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/put/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/put/responses/400/content/application~1json/examples/Example"]},{"code":"403","description":"A 403 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/put/responses/403/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/put/responses/403/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/put/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/put/responses/404/content/application~1json/examples/Example"]},{"code":"409","description":"A 409 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/put/responses/409/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/put/responses/409/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1webhooks~1{webhook_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/put/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/put/responses/400/content/application~1json/examples/Example"]}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/put/responses/403/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/put/responses/403/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/put/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/put/responses/404/content/application~1json/examples/Example"]}}},{"code":"409","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/put/responses/409/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/put/responses/409/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-webhooks/put-v1-webhooks--webhook-id-"}],"panels":[]}]},"httpPath":"/v1/webhooks/{webhook_id}"},{"label":"Delete account-level webhook by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-webhooks/delete-v1-webhooks--webhook-id-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-webhooks/delete-v1-webhooks--webhook-id-","metadata":{"seo":{"title":"Delete account-level webhook by ID","description":"Delete a specific account-level webhook by its webhook ID. This removes the webhook from all associated event types. Note: Webhook changes can take up to 10 minutes to become effective due to caching."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v1-webhooks--webhook-id-","name":"Delete account-level webhook by ID","isWebhook":false,"pointer":"/paths/~1v1~1webhooks~1{webhook_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete account-level webhook by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a specific account-level webhook by its webhook ID. This removes the webhook from all associated event types. Note: Webhook changes can take up to 10 minutes to become effective due to caching."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhook_id","in":"path","schemaId":"components/schemas/string","description":"The webhook ID to delete","required":true}],"pointer":"/paths/~1v1~1webhooks~1{webhook_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/webhooks/{webhook_id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"webhook_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","400","403","404"],"pointer":"/v1/webhooks/{webhook_id}","href":"account-webhooks/delete-v1-webhooks--webhook-id-","openApiOperationId":"DELETE-v1-webhooks--webhook-id-","summary":"Delete account-level webhook by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"A 204 response"},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/delete/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/delete/responses/400/content/application~1json/examples/Example"]},{"code":"403","description":"A 403 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/delete/responses/403/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/delete/responses/403/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/delete/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/delete/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1webhooks~1{webhook_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/delete/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/delete/responses/400/content/application~1json/examples/Example"]}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/delete/responses/403/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/delete/responses/403/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/delete/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1webhooks~1{webhook_id}/delete/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-webhooks/delete-v1-webhooks--webhook-id-"}],"panels":[]}]},"httpPath":"/v1/webhooks/{webhook_id}"}],"content":{"contentType":"group","meta":{"name":"Account Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Webhooks","showPageActions":true},{"nodeType":"markdoc","content":"Webhooks API to manage account-specific webhooks. You can create, retrieve, update, and delete webhooks programmatically. Account-level webhooks are configured independently for US and EU regions. When triggered, webhook URLs are deduplicated by event type, across account and domain levels to prevent redundant webhook sends."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/webhooks","summary":"List account-level webhooks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-webhooks/get-v1-webhooks","deprecated":false},{"title":"/v1/webhooks","summary":"Create an account-level webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-webhooks/post-v1-webhooks","deprecated":false},{"title":"/v1/webhooks","summary":"Delete account-level webhooks","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/account-webhooks/delete-v1-webhooks","deprecated":false},{"title":"/v1/webhooks/{webhook_id}","summary":"Get account-level webhook by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-webhooks/get-v1-webhooks--webhook-id-","deprecated":false},{"title":"/v1/webhooks/{webhook_id}","summary":"Update an account-level webhook","prefix":{"name":"put","color":"put"},"badges":[],"link":"/account-webhooks/put-v1-webhooks--webhook-id-","deprecated":false},{"title":"/v1/webhooks/{webhook_id}","summary":"Delete account-level webhook by ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/account-webhooks/delete-v1-webhooks--webhook-id-","deprecated":false}]}]}]}]}},{"type":"group","label":"Domain Webhooks","link":"/docs/mailgun/api-reference/send/mailgun/domain-webhooks","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-webhooks","items":[{"label":"Get domain webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-webhooks/get-v3-domains--domain--webhooks","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-webhooks/get-v3-domains--domain--webhooks","metadata":{"seo":{"title":"Get domain webhooks","description":"Returns all webhooks for the domain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-domains--domain--webhooks","name":"Get domain webhooks","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{domain}~1webhooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get domain webhooks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all webhooks for the domain."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"components/schemas/string","description":"Domain name you want webhooks for","required":true}],"pointer":"/paths/~1v3~1domains~1{domain}~1webhooks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/domains/{domain}/webhooks","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/domains/{domain}/webhooks","href":"domain-webhooks/get-v3-domains--domain--webhooks","openApiOperationId":"GET-v3-domains--domain--webhooks","summary":"Get domain webhooks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetAllDomainWebhooksResp","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetAllDomainWebhooksResp","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/get/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/get/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/get/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/get/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/get/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{domain}~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetAllDomainWebhooksResp","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetAllDomainWebhooksResp","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/get/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/get/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/get/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/get/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-webhooks/get-v3-domains--domain--webhooks"}],"panels":[]}]},"httpPath":"/v3/domains/{domain}/webhooks"},{"label":"Create a domain webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-webhooks/post-v3-domains--domain--webhooks","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-webhooks/post-v3-domains--domain--webhooks","metadata":{"seo":{"title":"Create a domain webhook","description":"Create a list of webhook URLs you'd like to receive Mailgun's POST requests containing event information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3-domains--domain--webhooks","name":"Create a domain webhook","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{domain}~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a domain webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a list of webhook URLs you'd like to receive Mailgun's POST requests containing event information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"components/schemas/string","description":"The domain name to create the webhook for","required":true}],"pointer":"/paths/~1v3~1domains~1{domain}~1webhooks/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domains-domain-webhooks-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/POST-v3-domains-domain-webhooks-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1domains~1{domain}~1webhooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/domains/{domain}/webhooks","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domains-domain-webhooks-multipart-form-data-RequestBody"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/domains/{domain}/webhooks","href":"domain-webhooks/post-v3-domains--domain--webhooks","openApiOperationId":"POST-v3-domains--domain--webhooks","summary":"Create a domain webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/POST-v3-domains-domain-webhooks-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domains-domain-webhooks-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-CreateDomainWebhookResp","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-CreateDomainWebhookResp","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/post/responses/400/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/post/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/post/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/post/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/post/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{domain}~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-CreateDomainWebhookResp","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-CreateDomainWebhookResp","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/post/responses/400/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/post/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/post/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/post/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain}~1webhooks/post/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-webhooks/post-v3-domains--domain--webhooks"}],"panels":[]}]},"httpPath":"/v3/domains/{domain}/webhooks"},{"label":"Get domain webhooks by type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-webhooks/get-v3-domains--domain-name--webhooks--webhook-name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-webhooks/get-v3-domains--domain-name--webhooks--webhook-name-","metadata":{"seo":{"title":"Get domain webhooks by type","description":"Get the list of url(s) for a webhook identified by its webhook_name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-domains--domain-name--webhooks--webhook-name-","name":"Get domain webhooks by type","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get domain webhooks by type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get the list of url(s) for a webhook identified by its webhook_name."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain name you want webhooks for","required":true},{"name":"webhook_name","in":"path","schemaId":"schema_262","description":"The webhook type you wish to retrieve.","required":true}],"pointer":"/paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/domains/{domain_name}/webhooks/{webhook_name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"webhook_name","in":"path","required":true,"schemaId":"schema_262"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/domains/{domain_name}/webhooks/{webhook_name}","href":"domain-webhooks/get-v3-domains--domain-name--webhooks--webhook-name-","openApiOperationId":"GET-v3-domains--domain-name--webhooks--webhook-name-","summary":"Get domain webhooks by type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetDomainWebhookResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetDomainWebhookResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/get/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/get/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/get/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/get/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/get/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetDomainWebhookResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetDomainWebhookResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/get/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/get/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/get/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/get/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-webhooks/get-v3-domains--domain-name--webhooks--webhook-name-"}],"panels":[]}]},"httpPath":"/v3/domains/{domain_name}/webhooks/{webhook_name}"},{"label":"Update domain webhook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-webhooks/put-v3-domains--domain-name--webhooks--webhook-name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-webhooks/put-v3-domains--domain-name--webhooks--webhook-name-","metadata":{"seo":{"title":"Update domain webhook","description":"Replace the list of urls by the given one with the url param. Here is the list of supported webhook: accepted, opened, clicked, unsubscribed, delivered, permanent_fail, temporary_fail and complained."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v3-domains--domain-name--webhooks--webhook-name-","name":"Update domain webhook","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update domain webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replace the list of urls by the given one with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" param. Here is the list of supported webhook: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"opened"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clicked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unsubscribed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delivered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"permanent_fail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"temporary_fail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"complained"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"The name of the domain you want to get webhook from","required":true},{"name":"webhook_name","in":"path","schemaId":"schema_262","description":"The webhook type to update.","required":true}],"pointer":"/paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domains-domain_name-webhooks-webhook_name-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/PUT-v3-domains-domain_name-webhooks-webhook_name-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/domains/{domain_name}/webhooks/{webhook_name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"webhook_name","in":"path","required":true,"schemaId":"schema_262"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domains-domain_name-webhooks-webhook_name-multipart-form-data-RequestBody"}},"responseCodes":["200","400","401","404"],"pointer":"/v3/domains/{domain_name}/webhooks/{webhook_name}","href":"domain-webhooks/put-v3-domains--domain-name--webhooks--webhook-name-","openApiOperationId":"PUT-v3-domains--domain-name--webhooks--webhook-name-","summary":"Update domain webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/PUT-v3-domains-domain_name-webhooks-webhook_name-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domains-domain_name-webhooks-webhook_name-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-CreateDomainWebhookResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-CreateDomainWebhookResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/responses/400/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-CreateDomainWebhookResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-CreateDomainWebhookResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/responses/400/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-webhooks/put-v3-domains--domain-name--webhooks--webhook-name-"}],"panels":[]}]},"httpPath":"/v3/domains/{domain_name}/webhooks/{webhook_name}"},{"label":"Delete domain webhooks by type","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-webhooks/delete-v3-domains--domain-name--webhooks--webhook-name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-webhooks/delete-v3-domains--domain-name--webhooks--webhook-name-","metadata":{"seo":{"title":"Delete domain webhooks by type","description":"Remove all url(s) for a specified webhook type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3-domains--domain-name--webhooks--webhook-name-","name":"Delete domain webhooks by type","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete domain webhooks by type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove all url(s) for a specified webhook type."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"The domain name you want to delete the webhook(s) for","required":true},{"name":"webhook_name","in":"path","schemaId":"schema_262","description":"The name of the webhook to delete.","required":true}],"pointer":"/paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/domains/{domain_name}/webhooks/{webhook_name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"webhook_name","in":"path","required":true,"schemaId":"schema_262"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/domains/{domain_name}/webhooks/{webhook_name}","href":"domain-webhooks/delete-v3-domains--domain-name--webhooks--webhook-name-","openApiOperationId":"DELETE-v3-domains--domain-name--webhooks--webhook-name-","summary":"Delete domain webhooks by type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-CreateDomainWebhookResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-CreateDomainWebhookResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/delete/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/delete/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/delete/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/delete/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/delete/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-CreateDomainWebhookResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-CreateDomainWebhookResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/delete/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/delete/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/delete/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/delete/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-webhooks/delete-v3-domains--domain-name--webhooks--webhook-name-"}],"panels":[]}]},"httpPath":"/v3/domains/{domain_name}/webhooks/{webhook_name}"},{"label":"Update domain webhooks (v4)","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-webhooks/put-v4-domains--domain--webhooks","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-webhooks/put-v4-domains--domain--webhooks","metadata":{"seo":{"title":"Update domain webhooks (v4)","description":"Update webhook URL to associate it with different event types. This replaces the existing event type associations for the given URL."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v4-domains--domain--webhooks","name":"Update domain webhooks (v4)","isWebhook":false,"pointer":"/paths/~1v4~1domains~1{domain}~1webhooks/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update domain webhooks (v4)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update webhook URL to associate it with different event types. This replaces the existing event type associations for the given URL."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"components/schemas/string","description":"The domain name to update webhooks for","required":true}],"pointer":"/paths/~1v4~1domains~1{domain}~1webhooks/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/PUT-v4-domains-domain-webhooks-application-x-www-form-urlencoded-RequestBody"}},"schemaId":"components/schemas/PUT-v4-domains-domain-webhooks-application-x-www-form-urlencoded-RequestBody","pointer":"/paths/~1v4~1domains~1{domain}~1webhooks/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v4/domains/{domain}/webhooks","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/PUT-v4-domains-domain-webhooks-application-x-www-form-urlencoded-RequestBody"}},"responseCodes":["200","400","401","404"],"pointer":"/v4/domains/{domain}/webhooks","href":"domain-webhooks/put-v4-domains--domain--webhooks","openApiOperationId":"PUT-v4-domains--domain--webhooks","summary":"Update domain webhooks (v4)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/PUT-v4-domains-domain-webhooks-application-x-www-form-urlencoded-RequestBody","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/PUT-v4-domains-domain-webhooks-application-x-www-form-urlencoded-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetAllDomainWebhooksResp","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetAllDomainWebhooksResp","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/put/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/put/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/put/responses/400/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/put/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/put/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/put/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/put/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v4~1domains~1{domain}~1webhooks/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetAllDomainWebhooksResp","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetAllDomainWebhooksResp","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/put/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/put/responses/400/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/put/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/put/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/put/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/put/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-webhooks/put-v4-domains--domain--webhooks"}],"panels":[]}]},"httpPath":"/v4/domains/{domain}/webhooks"},{"label":"Create domain webhooks (v4)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-webhooks/post-v4-domains--domain--webhooks","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-webhooks/post-v4-domains--domain--webhooks","metadata":{"seo":{"title":"Create domain webhooks (v4)","description":"Create webhook URLs for multiple event types in a single operation. This v4 endpoint allows associating one URL with multiple webhook event types."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v4-domains--domain--webhooks","name":"Create domain webhooks (v4)","isWebhook":false,"pointer":"/paths/~1v4~1domains~1{domain}~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create domain webhooks (v4)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create webhook URLs for multiple event types in a single operation. This v4 endpoint allows associating one URL with multiple webhook event types."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"components/schemas/string","description":"The domain name to create webhooks for","required":true}],"pointer":"/paths/~1v4~1domains~1{domain}~1webhooks/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/POST-v4-domains-domain-webhooks-application-x-www-form-urlencoded-RequestBody"}},"schemaId":"components/schemas/POST-v4-domains-domain-webhooks-application-x-www-form-urlencoded-RequestBody","pointer":"/paths/~1v4~1domains~1{domain}~1webhooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/domains/{domain}/webhooks","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/POST-v4-domains-domain-webhooks-application-x-www-form-urlencoded-RequestBody"}},"responseCodes":["200","400","401","404"],"pointer":"/v4/domains/{domain}/webhooks","href":"domain-webhooks/post-v4-domains--domain--webhooks","openApiOperationId":"POST-v4-domains--domain--webhooks","summary":"Create domain webhooks (v4)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/POST-v4-domains-domain-webhooks-application-x-www-form-urlencoded-RequestBody","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/POST-v4-domains-domain-webhooks-application-x-www-form-urlencoded-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetAllDomainWebhooksResp","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetAllDomainWebhooksResp","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/post/responses/400/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/post/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/post/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/post/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/post/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v4~1domains~1{domain}~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetAllDomainWebhooksResp","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetAllDomainWebhooksResp","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/post/responses/400/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/post/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/post/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/post/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/post/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-webhooks/post-v4-domains--domain--webhooks"}],"panels":[]}]},"httpPath":"/v4/domains/{domain}/webhooks"},{"label":"Delete domain webhooks (v4)","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-webhooks/delete-v4-domains--domain--webhooks","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-webhooks/delete-v4-domains--domain--webhooks","metadata":{"seo":{"title":"Delete domain webhooks (v4)","description":"Delete webhook URLs from all event types they are associated with. Supports deleting multiple URLs at once by repeating the url query parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v4-domains--domain--webhooks","name":"Delete domain webhooks (v4)","isWebhook":false,"pointer":"/paths/~1v4~1domains~1{domain}~1webhooks/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete domain webhooks (v4)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete webhook URLs from all event types they are associated with. Supports deleting multiple URLs at once by repeating the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"components/schemas/string","description":"The domain name to delete webhooks from","required":true}],"pointer":"/paths/~1v4~1domains~1{domain}~1webhooks/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"url","in":"query","schemaId":"schema_263","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The webhook URL to delete. The URL is removed from all event types it's associated with. To delete multiple URLs in one request, repeat the parameter (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?url=https://a.example&url=https://b.example"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v4~1domains~1{domain}~1webhooks/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v4/domains/{domain}/webhooks","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"url","in":"query","required":true,"schemaId":"schema_263"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v4/domains/{domain}/webhooks","href":"domain-webhooks/delete-v4-domains--domain--webhooks","openApiOperationId":"DELETE-v4-domains--domain--webhooks","summary":"Delete domain webhooks (v4)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetAllDomainWebhooksResp","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetAllDomainWebhooksResp","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/delete/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/delete/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/delete/responses/400/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/delete/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/delete/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/delete/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/delete/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v4~1domains~1{domain}~1webhooks/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetAllDomainWebhooksResp","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-domains-httpapi-GetAllDomainWebhooksResp","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/delete/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/delete/responses/400/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/delete/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/delete/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/delete/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1domains~1{domain}~1webhooks/delete/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-webhooks/delete-v4-domains--domain--webhooks"}],"panels":[]}]},"httpPath":"/v4/domains/{domain}/webhooks"}],"content":{"contentType":"group","meta":{"name":"Domain Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Domain Webhooks","showPageActions":true},{"nodeType":"markdoc","content":"Webhooks API to manage domain-specific webhooks. You can create, retrieve, update, and delete webhooks programmatically. When triggered, webhook URLs are deduplicated by event type, across account and domain levels to prevent redundant webhook sends."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/domains/{domain}/webhooks","summary":"Get domain webhooks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain-webhooks/get-v3-domains--domain--webhooks","deprecated":false},{"title":"/v3/domains/{domain}/webhooks","summary":"Create a domain webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/domain-webhooks/post-v3-domains--domain--webhooks","deprecated":false},{"title":"/v3/domains/{domain_name}/webhooks/{webhook_name}","summary":"Get domain webhooks by type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain-webhooks/get-v3-domains--domain-name--webhooks--webhook-name-","deprecated":false},{"title":"/v3/domains/{domain_name}/webhooks/{webhook_name}","summary":"Update domain webhook","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain-webhooks/put-v3-domains--domain-name--webhooks--webhook-name-","deprecated":false},{"title":"/v3/domains/{domain_name}/webhooks/{webhook_name}","summary":"Delete domain webhooks by type","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/domain-webhooks/delete-v3-domains--domain-name--webhooks--webhook-name-","deprecated":false},{"title":"/v4/domains/{domain}/webhooks","summary":"Update domain webhooks (v4)","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain-webhooks/put-v4-domains--domain--webhooks","deprecated":false},{"title":"/v4/domains/{domain}/webhooks","summary":"Create domain webhooks (v4)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/domain-webhooks/post-v4-domains--domain--webhooks","deprecated":false},{"title":"/v4/domains/{domain}/webhooks","summary":"Delete domain webhooks (v4)","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/domain-webhooks/delete-v4-domains--domain--webhooks","deprecated":false}]}]}]}]}},{"type":"separator","label":"Reporting","content":null},{"type":"group","label":"Metrics","link":"/docs/mailgun/api-reference/send/mailgun/metrics","routeSlug":"/docs/mailgun/api-reference/send/mailgun/metrics","items":[{"type":"link","label":"Metrics vs. Stats API","link":"/docs/mailgun/api-reference/send/mailgun/metrics/metrics-vs.-stats-api","routeSlug":"/docs/mailgun/api-reference/send/mailgun/metrics/metrics-vs.-stats-api","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Metrics vs. Stats API"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"metrics/metrics-vs.-stats-api"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metrics vs. Stats API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Metrics API is the modern replacement for the deprecated Stats API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stats API (Deprecated)"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metrics API (Current)"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexibility"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited filtering"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Advanced filtering with logical operators"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dimensions"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fixed groupings"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible dimension combinations"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metrics"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic counts"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comprehensive metrics including rates"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Performance"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Slower"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optimized for large datasets"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Future Support"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"None"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Active development"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Migration:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If you're using the Stats API, plan to migrate to the Metrics API for continued support and new features."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"What Are Metrics?","link":"/docs/mailgun/api-reference/send/mailgun/metrics/what-are-metrics","routeSlug":"/docs/mailgun/api-reference/send/mailgun/metrics/what-are-metrics","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"What Are Metrics?"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"metrics/what-are-metrics"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What Are Metrics?"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metrics are quantitative measurements of your email activity. The Mailgun platform collects event data in real-time and aggregates it into meaningful metrics that help you understand how your emails are performing."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Types of Metrics","link":"/docs/mailgun/api-reference/send/mailgun/metrics/types-of-metrics","routeSlug":"/docs/mailgun/api-reference/send/mailgun/metrics/types-of-metrics","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Types of Metrics"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"metrics/types-of-metrics"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Types of Metrics"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mailgun provides two categories of metrics:"},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Sending Metrics (via ","link":"/docs/mailgun/api-reference/send/mailgun/metrics/sending-metrics-(via","routeSlug":"/docs/mailgun/api-reference/send/mailgun/metrics/sending-metrics-(via","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Sending Metrics (via "},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"metrics/sending-metrics-(via"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sending Metrics (via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v1/analytics/metrics"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These metrics track the lifecycle and performance of your outbound emails:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Volume Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Messages accepted, delivered, failed, queued"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Engagement Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Opens, clicks, unsubscribes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deliverability Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Bounces (permanent and temporary), complaints (spam reports)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Delivered rate, open rate, click rate, bounce rate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ESP-Specific Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Performance broken down by email service provider"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/reporting/metric-definitions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"metric definitions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a complete list of available metrics."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Usage Metrics (via ","link":"/docs/mailgun/api-reference/send/mailgun/metrics/usage-metrics-(via","routeSlug":"/docs/mailgun/api-reference/send/mailgun/metrics/usage-metrics-(via","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Usage Metrics (via "},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"metrics/usage-metrics-(via"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage Metrics (via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v1/analytics/usage/metrics"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These metrics track your consumption of Mailgun services and features:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email Validation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Single validations, bulk validations, API calls"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email Preview"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Preview generation counts and failures"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blocklist Monitoring"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Domain and IP blocklist checks"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accessibility Checks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Accessibility validation counts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Seed Testing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Seed test campaigns sent"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Core Concepts","link":"/docs/mailgun/api-reference/send/mailgun/metrics/core-concepts","routeSlug":"/docs/mailgun/api-reference/send/mailgun/metrics/core-concepts","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Core Concepts"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"metrics/core-concepts"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Core Concepts"},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Dimensions","link":"/docs/mailgun/api-reference/send/mailgun/metrics/dimensions","routeSlug":"/docs/mailgun/api-reference/send/mailgun/metrics/dimensions","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Dimensions"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"metrics/dimensions"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dimensions"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dimensions are the attributes by which you can slice and group your metrics data. Think of them as the \"categories\" or \"labels\" for your data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available Dimensions:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/reporting/dimensions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dimensions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a complete list of available dimensions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If you query with dimensions "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"time\", \"domain\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your results will be grouped by time period for each sending domain."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Resolution","link":"/docs/mailgun/api-reference/send/mailgun/metrics/resolution","routeSlug":"/docs/mailgun/api-reference/send/mailgun/metrics/resolution","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Resolution"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"metrics/resolution"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resolution"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resolution determines the time granularity of your results:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"hour"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Data grouped by hour (useful for real-time monitoring)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"day"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Data grouped by day (most common for daily reports)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"month"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Data grouped by month (useful for trend analysis)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resolution you choose affects how the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dimension groups your data."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Time Range Selection","link":"/docs/mailgun/api-reference/send/mailgun/metrics/time-range-selection","routeSlug":"/docs/mailgun/api-reference/send/mailgun/metrics/time-range-selection","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Time Range Selection"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"metrics/time-range-selection"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time Range Selection"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You have flexible options for specifying the time range:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Option 1: Start and End Dates"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n\"start\": \"Mon, 13 Nov 2023 00:00:00 -0600\",\n\"end\": \"Mon, 20 Nov 2023 23:59:59 -0600\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n\"start\": \"Mon, 13 Nov 2023 00:00:00 -0600\",\n\"end\": \"Mon, 20 Nov 2023 23:59:59 -0600\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Option 2: Duration"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n\"duration\": \"7d\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n\"duration\": \"7d\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This calculates the start date and end date automatically (7 days before the today)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date Format:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" RFC 2822 format with timezone support"},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Filters","link":"/docs/mailgun/api-reference/send/mailgun/metrics/filters","routeSlug":"/docs/mailgun/api-reference/send/mailgun/metrics/filters","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Filters"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"metrics/filters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters allow you to narrow down your data to specific criteria. The filter system uses a logical structure:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n\"filter\": {\n  \"AND\": [\n    {\n      \"attribute\": \"domain\",\n      \"comparator\": \"=\",\n      \"values\": [\n        {\"value\": \"example.com\"}\n      ]\n    },\n    {\n      \"attribute\": \"tag\",\n      \"comparator\": \"=\",\n      \"values\": [\n        {\"value\": \"newsletter\"}\n      ]\n    }\n  ]\n}\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n\"filter\": {\n  \"AND\": [\n    {\n      \"attribute\": \"domain\",\n      \"comparator\": \"=\",\n      \"values\": [\n        {\"value\": \"example.com\"}\n      ]\n    },\n    {\n      \"attribute\": \"tag\",\n      \"comparator\": \"=\",\n      \"values\": [\n        {\"value\": \"newsletter\"}\n      ]\n    }\n  ]\n}\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Filters only support the \"AND\" operator. \"OR\" is not supported.  In the example above, only data where the sending domain equals "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"example.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the tag equals "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newsletter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter Components:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attribute"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The field to filter on (domain, tag, subaccount)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"comparator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The comparison operator (=, !=, contains, not contains)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Array of values to match against"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Aggregates","link":"/docs/mailgun/api-reference/send/mailgun/metrics/aggregates","routeSlug":"/docs/mailgun/api-reference/send/mailgun/metrics/aggregates","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Aggregates"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"metrics/aggregates"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aggregates"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include_aggregates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the API returns top-level summary statistics across all your queried data. This gives you totals and averages without having to sum the individual items yourself."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Subaccounts","link":"/docs/mailgun/api-reference/send/mailgun/metrics/subaccounts","routeSlug":"/docs/mailgun/api-reference/send/mailgun/metrics/subaccounts","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Subaccounts"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"metrics/subaccounts"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subaccounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you use Mailgun's subaccount feature, you can:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query metrics for a specific subaccount using filters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include all subaccounts' data with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include_subaccounts: true"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View aggregated data across all subaccounts"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Data Retention","link":"/docs/mailgun/api-reference/send/mailgun/metrics/data-retention","routeSlug":"/docs/mailgun/api-reference/send/mailgun/metrics/data-retention","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Data Retention"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"metrics/data-retention"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data Retention"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mailgun retains metrics data for different durations based on resolution:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hourly"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 60 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Daily"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 1 year"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monthly"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indefinitely"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Pagination","link":"/docs/mailgun/api-reference/send/mailgun/metrics/pagination","routeSlug":"/docs/mailgun/api-reference/send/mailgun/metrics/pagination","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Pagination"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"metrics/pagination"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For queries that return large result sets, the API uses offset-based pagination with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request attributes."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specifies how many items to offset (skip) from the beginning of the result set."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specifies the maximum number of items to return in a single request."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defaults and limits:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default page size varies by dimension. Default for time dimension is 1500 items. All other dimensions default to 10 items."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 1500 for the time dimension and 1000 for all other dimensions."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How pagination works:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skip=0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a desired "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit=1000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the next page by increasing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First page: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skip=0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit=1000"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Second page: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skip=1000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit=1000"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Third page: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skip=2000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit=1000"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Continue paging until fewer items than the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are returned."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional details:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object containing the total number of available items."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results can be sorted using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"time:asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"time:desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For consistent pagination, use a deterministic sort order."},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Rate Limits and Quotas","link":"/docs/mailgun/api-reference/send/mailgun/metrics/rate-limits-and-quotas","routeSlug":"/docs/mailgun/api-reference/send/mailgun/metrics/rate-limits-and-quotas","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Rate Limits and Quotas"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"metrics/rate-limits-and-quotas"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limits and Quotas"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API calls are subject to a rate limit of 500 requests every 10 seconds"},"children":[]}]}]}]}]}],"panels":[]}]}},{"label":"Query account metrics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/metrics/post-v1-analytics-metrics","routeSlug":"/docs/mailgun/api-reference/send/mailgun/metrics/post-v1-analytics-metrics","metadata":{"seo":{"title":"Query account metrics","description":"Queries filtered metrics for an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v1-analytics-metrics","name":"Query account metrics","isWebhook":false,"pointer":"/paths/~1v1~1analytics~1metrics/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query account metrics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Queries filtered metrics for an account"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","none"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-analytics-client-golang-Query","exampleIds":["paths/~1v1~1analytics~1metrics/post/requestBody/content/application~1json/examples/Example"]},"none":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v1~1analytics~1metrics/post/requestBody/content/none/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-analytics-client-golang-Query","exampleIds":["paths/~1v1~1analytics~1metrics/post/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v1~1analytics~1metrics/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/analytics/metrics","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-analytics-client-golang-Query","exampleIds":["paths/~1v1~1analytics~1metrics/post/requestBody/content/application~1json/examples/Example"]},"none":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v1~1analytics~1metrics/post/requestBody/content/none/examples/Example"]}},"responseCodes":["200","400"],"pointer":"/v1/analytics/metrics","href":"metrics/post-v1-analytics-metrics","openApiOperationId":"POST-v1-analytics-metrics","summary":"Query account metrics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-analytics-client-golang-Query","exampleIds":["paths/~1v1~1analytics~1metrics/post/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json","none"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-analytics-client-golang-Query","exampleIds":["paths/~1v1~1analytics~1metrics/post/requestBody/content/application~1json/examples/Example"]},"none":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v1~1analytics~1metrics/post/requestBody/content/none/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-analytics-internal-api-RegularMetricsResponse","exampleIds":["paths/~1v1~1analytics~1metrics/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-analytics-internal-api-RegularMetricsResponse","exampleIds":["paths/~1v1~1analytics~1metrics/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1analytics~1metrics/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1analytics~1metrics/post/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1analytics~1metrics/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-analytics-internal-api-RegularMetricsResponse","exampleIds":["paths/~1v1~1analytics~1metrics/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-analytics-internal-api-RegularMetricsResponse","exampleIds":["paths/~1v1~1analytics~1metrics/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1analytics~1metrics/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1analytics~1metrics/post/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/metrics/post-v1-analytics-metrics"}],"panels":[]}]},"httpPath":"/v1/analytics/metrics"},{"label":"Query account usage metrics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/metrics/post-v1-analytics-usage-metrics","routeSlug":"/docs/mailgun/api-reference/send/mailgun/metrics/post-v1-analytics-usage-metrics","metadata":{"seo":{"title":"Query account usage metrics","description":"Queries filtered usage metrics for an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v1-analytics-usage-metrics","name":"Query account usage metrics","isWebhook":false,"pointer":"/paths/~1v1~1analytics~1usage~1metrics/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query account usage metrics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Queries filtered usage metrics for an account"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","none"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-analytics-client-golang-UsageQuery","exampleIds":["paths/~1v1~1analytics~1usage~1metrics/post/requestBody/content/application~1json/examples/Example"]},"none":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v1~1analytics~1usage~1metrics/post/requestBody/content/none/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-analytics-client-golang-UsageQuery","exampleIds":["paths/~1v1~1analytics~1usage~1metrics/post/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v1~1analytics~1usage~1metrics/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/analytics/usage/metrics","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-analytics-client-golang-UsageQuery","exampleIds":["paths/~1v1~1analytics~1usage~1metrics/post/requestBody/content/application~1json/examples/Example"]},"none":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v1~1analytics~1usage~1metrics/post/requestBody/content/none/examples/Example"]}},"responseCodes":["200","400"],"pointer":"/v1/analytics/usage/metrics","href":"metrics/post-v1-analytics-usage-metrics","openApiOperationId":"POST-v1-analytics-usage-metrics","summary":"Query account usage metrics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-analytics-client-golang-UsageQuery","exampleIds":["paths/~1v1~1analytics~1usage~1metrics/post/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json","none"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-analytics-client-golang-UsageQuery","exampleIds":["paths/~1v1~1analytics~1usage~1metrics/post/requestBody/content/application~1json/examples/Example"]},"none":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v1~1analytics~1usage~1metrics/post/requestBody/content/none/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-analytics-internal-api-UsageMetricsResponse","exampleIds":["paths/~1v1~1analytics~1usage~1metrics/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-analytics-internal-api-UsageMetricsResponse","exampleIds":["paths/~1v1~1analytics~1usage~1metrics/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1analytics~1usage~1metrics/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1analytics~1usage~1metrics/post/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1analytics~1usage~1metrics/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-analytics-internal-api-UsageMetricsResponse","exampleIds":["paths/~1v1~1analytics~1usage~1metrics/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-analytics-internal-api-UsageMetricsResponse","exampleIds":["paths/~1v1~1analytics~1usage~1metrics/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1analytics~1usage~1metrics/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1analytics~1usage~1metrics/post/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/metrics/post-v1-analytics-usage-metrics"}],"panels":[]}]},"httpPath":"/v1/analytics/usage/metrics"}],"content":{"contentType":"group","meta":{"name":"Metrics"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Metrics","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Mailgun Metrics API provides programmatic access to detailed analytics data about your email sending activity. This API allows you to query, filter, and analyze email performance metrics to gain insights into deliverability, engagement, and overall sending health."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/analytics/metrics","summary":"Query account metrics","prefix":{"name":"post","color":"post"},"badges":[],"link":"/metrics/post-v1-analytics-metrics","deprecated":false},{"title":"/v1/analytics/usage/metrics","summary":"Query account usage metrics","prefix":{"name":"post","color":"post"},"badges":[],"link":"/metrics/post-v1-analytics-usage-metrics","deprecated":false}]}]}]}]}},{"type":"group","label":"Logs","link":"/docs/mailgun/api-reference/send/mailgun/logs","routeSlug":"/docs/mailgun/api-reference/send/mailgun/logs","items":[{"label":"List logs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/logs/post-v1-analytics-logs","routeSlug":"/docs/mailgun/api-reference/send/mailgun/logs/post-v1-analytics-logs","metadata":{"seo":{"title":"List logs","description":"Gets customer event logs for an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v1-analytics-logs","name":"List logs","isWebhook":false,"pointer":"/paths/~1v1~1analytics~1logs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List logs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets customer event logs for an account"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]},{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-LogsRequest","exampleIds":["paths/~1v1~1analytics~1logs/post/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-LogsRequest","exampleIds":["paths/~1v1~1analytics~1logs/post/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v1~1analytics~1logs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/analytics/logs","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-LogsRequest","exampleIds":["paths/~1v1~1analytics~1logs/post/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["200","400"],"pointer":"/v1/analytics/logs","href":"logs/post-v1-analytics-logs","openApiOperationId":"POST-v1-analytics-logs","summary":"List logs","securityGroups":[{"basicAuth":[]},{"basicAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-LogsRequest","exampleIds":["paths/~1v1~1analytics~1logs/post/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-LogsRequest","exampleIds":["paths/~1v1~1analytics~1logs/post/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-LogsResponse","exampleIds":["paths/~1v1~1analytics~1logs/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-LogsResponse","exampleIds":["paths/~1v1~1analytics~1logs/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1analytics~1logs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-LogsResponse","exampleIds":["paths/~1v1~1analytics~1logs/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-LogsResponse","exampleIds":["paths/~1v1~1analytics~1logs/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/logs/post-v1-analytics-logs"}],"panels":[]}]},"httpPath":"/v1/analytics/logs"}],"content":{"contentType":"group","meta":{"name":"Logs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Logs","showPageActions":true},{"nodeType":"markdoc","content":"Mailgun keeps track of every inbound and outbound message event and stores this log data. Using this logs API, this data can be queried and filtered to provide insights into the health of your email infrastructure."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/analytics/logs","summary":"List logs","prefix":{"name":"post","color":"post"},"badges":[],"link":"/logs/post-v1-analytics-logs","deprecated":false}]}]}]}]}},{"type":"group","label":"Bounce Classification","link":"/docs/mailgun/api-reference/send/mailgun/bounce-classification","routeSlug":"/docs/mailgun/api-reference/send/mailgun/bounce-classification","items":[{"label":"List statistic v2","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/bounce-classification/post-v2-bounce-classification-metrics","routeSlug":"/docs/mailgun/api-reference/send/mailgun/bounce-classification/post-v2-bounce-classification-metrics","metadata":{"seo":{"title":"List statistic v2","description":"Items that have no bounces and no delays(classified_failures_count==0) are not returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v2-bounce-classification-metrics","name":"List statistic v2","isWebhook":false,"pointer":"/paths/~1v2~1bounce-classification~1metrics/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List statistic v2","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Items that have no bounces and no delays(classified_failures_count==0) are not returned."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-api-MetricsRequest","exampleIds":["paths/~1v2~1bounce-classification~1metrics/post/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-api-MetricsRequest","exampleIds":["paths/~1v2~1bounce-classification~1metrics/post/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v2~1bounce-classification~1metrics/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/bounce-classification/metrics","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-api-MetricsRequest","exampleIds":["paths/~1v2~1bounce-classification~1metrics/post/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["200"],"pointer":"/v2/bounce-classification/metrics","href":"bounce-classification/post-v2-bounce-classification-metrics","openApiOperationId":"POST-v2-bounce-classification-metrics","summary":"List statistic v2"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-api-MetricsRequest","exampleIds":["paths/~1v2~1bounce-classification~1metrics/post/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-api-MetricsRequest","exampleIds":["paths/~1v2~1bounce-classification~1metrics/post/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-api-MetricsResponse","exampleIds":["paths/~1v2~1bounce-classification~1metrics/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-api-MetricsResponse","exampleIds":["paths/~1v2~1bounce-classification~1metrics/post/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v2~1bounce-classification~1metrics/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-api-MetricsResponse","exampleIds":["paths/~1v2~1bounce-classification~1metrics/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-api-MetricsResponse","exampleIds":["paths/~1v2~1bounce-classification~1metrics/post/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bounce-classification/post-v2-bounce-classification-metrics"}],"panels":[]}]},"httpPath":"/v2/bounce-classification/metrics"},{"label":"List statistics, ordered by total bounces","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/bounce-classification/get-v1-bounce-classification-stats","routeSlug":"/docs/mailgun/api-reference/send/mailgun/bounce-classification/get-v1-bounce-classification-stats","metadata":{"seo":{"title":"List statistics, ordered by total bounces","description":"Deprecated: use POST /v2/bounce-classification/metrics instead"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-bounce-classification-stats","name":"List statistics, ordered by total bounces","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1bounce-classification~1stats/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List statistics, ordered by total bounces","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deprecated: use POST /v2/bounce-classification/metrics instead"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"group","in":"query","schemaId":"components/schemas/string","description":"Group response by fields: subaccount.id, domain.name, entity-id, rule-id"},{"name":"limit","in":"query","schemaId":"schema_260","description":"Limits the number of items returned in a response"},{"name":"include_subaccounts","in":"query","schemaId":"schema_264","description":"Include subaccounts"}],"pointer":"/paths/~1v1~1bounce-classification~1stats/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/bounce-classification/stats","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"group","in":"query","schemaId":"components/schemas/string"},{"name":"limit","in":"query","schemaId":"schema_260"},{"name":"include_subaccounts","in":"query","schemaId":"schema_264"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/bounce-classification/stats","href":"bounce-classification/get-v1-bounce-classification-stats","openApiOperationId":"GET-v1-bounce-classification-stats","summary":"List statistics, ordered by total bounces"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-api-ListStatsResp","exampleIds":["paths/~1v1~1bounce-classification~1stats/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-api-ListStatsResp","exampleIds":["paths/~1v1~1bounce-classification~1stats/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1bounce-classification~1stats/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-api-ListStatsResp","exampleIds":["paths/~1v1~1bounce-classification~1stats/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-api-ListStatsResp","exampleIds":["paths/~1v1~1bounce-classification~1stats/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bounce-classification/get-v1-bounce-classification-stats"}],"panels":[]}]},"httpPath":"/v1/bounce-classification/stats"},{"label":"List domains statistic per account","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/bounce-classification/get-v1-bounce-classification-domains","routeSlug":"/docs/mailgun/api-reference/send/mailgun/bounce-classification/get-v1-bounce-classification-domains","metadata":{"seo":{"title":"List domains statistic per account","description":"Deprecated: use POST /v2/bounce-classification/metrics"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-bounce-classification-domains","name":"List domains statistic per account","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1bounce-classification~1domains/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List domains statistic per account","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deprecated: use POST /v2/bounce-classification/metrics"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_260","description":"Limits the number of items returned in a response"},{"name":"skip","in":"query","schemaId":"schema_260","description":"Skips N items in a response"},{"name":"query","in":"query","schemaId":"components/schemas/string","description":"Query filter, e.g.: 'domain.name:example.com'"},{"name":"include_subaccounts","in":"query","schemaId":"schema_264","description":"Include subaccounts"}],"pointer":"/paths/~1v1~1bounce-classification~1domains/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/bounce-classification/domains","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_260"},{"name":"skip","in":"query","schemaId":"schema_260"},{"name":"query","in":"query","schemaId":"components/schemas/string"},{"name":"include_subaccounts","in":"query","schemaId":"schema_264"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/bounce-classification/domains","href":"bounce-classification/get-v1-bounce-classification-domains","openApiOperationId":"GET-v1-bounce-classification-domains","summary":"List domains statistic per account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-api-ListAccountStatsResp","exampleIds":["paths/~1v1~1bounce-classification~1domains/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-api-ListAccountStatsResp","exampleIds":["paths/~1v1~1bounce-classification~1domains/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1bounce-classification~1domains/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-api-ListAccountStatsResp","exampleIds":["paths/~1v1~1bounce-classification~1domains/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-api-ListAccountStatsResp","exampleIds":["paths/~1v1~1bounce-classification~1domains/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bounce-classification/get-v1-bounce-classification-domains"}],"panels":[]}]},"httpPath":"/v1/bounce-classification/domains"},{"label":"List statistic per domain","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/bounce-classification/get-v1-bounce-classification-domains--domain--entities","routeSlug":"/docs/mailgun/api-reference/send/mailgun/bounce-classification/get-v1-bounce-classification-domains--domain--entities","metadata":{"seo":{"title":"List statistic per domain","description":"Deprecated: use POST /v2/bounce-classification/metrics"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-bounce-classification-domains--domain--entities","name":"List statistic per domain","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1bounce-classification~1domains~1{domain}~1entities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List statistic per domain","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deprecated: use POST /v2/bounce-classification/metrics"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"components/schemas/string","description":"The sender domain name","required":true}],"pointer":"/paths/~1v1~1bounce-classification~1domains~1{domain}~1entities/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_subaccounts","in":"query","schemaId":"schema_264","description":"Include subaccounts"}],"pointer":"/paths/~1v1~1bounce-classification~1domains~1{domain}~1entities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/bounce-classification/domains/{domain}/entities","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"include_subaccounts","in":"query","schemaId":"schema_264"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/bounce-classification/domains/{domain}/entities","href":"bounce-classification/get-v1-bounce-classification-domains--domain--entities","openApiOperationId":"GET-v1-bounce-classification-domains--domain--entities","summary":"List statistic per domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-api-ListDomainStatsResp","exampleIds":["paths/~1v1~1bounce-classification~1domains~1{domain}~1entities/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-api-ListDomainStatsResp","exampleIds":["paths/~1v1~1bounce-classification~1domains~1{domain}~1entities/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1bounce-classification~1domains~1{domain}~1entities/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-api-ListDomainStatsResp","exampleIds":["paths/~1v1~1bounce-classification~1domains~1{domain}~1entities/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-api-ListDomainStatsResp","exampleIds":["paths/~1v1~1bounce-classification~1domains~1{domain}~1entities/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bounce-classification/get-v1-bounce-classification-domains--domain--entities"}],"panels":[]}]},"httpPath":"/v1/bounce-classification/domains/{domain}/entities"},{"label":"List statistic per entity","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/bounce-classification/get-v1-bounce-classification-domains--domain--entities--entity-id--rules","routeSlug":"/docs/mailgun/api-reference/send/mailgun/bounce-classification/get-v1-bounce-classification-domains--domain--entities--entity-id--rules","metadata":{"seo":{"title":"List statistic per entity","description":"Deprecated: use POST /v2/bounce-classification/metrics"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-bounce-classification-domains--domain--entities--entity-id--rules","name":"List statistic per entity","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1bounce-classification~1domains~1{domain}~1entities~1{entity-id}~1rules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List statistic per entity","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deprecated: use POST /v2/bounce-classification/metrics"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"components/schemas/string","description":"The sender domain name","required":true},{"name":"entity-id","in":"path","schemaId":"components/schemas/string","description":"The entity ID(Email Service Entity or Spam Filter / BL)","required":true}],"pointer":"/paths/~1v1~1bounce-classification~1domains~1{domain}~1entities~1{entity-id}~1rules/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_subaccounts","in":"query","schemaId":"schema_264","description":"Include subaccounts"}],"pointer":"/paths/~1v1~1bounce-classification~1domains~1{domain}~1entities~1{entity-id}~1rules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/bounce-classification/domains/{domain}/entities/{entity-id}/rules","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"entity-id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"include_subaccounts","in":"query","schemaId":"schema_264"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/v1/bounce-classification/domains/{domain}/entities/{entity-id}/rules","href":"bounce-classification/get-v1-bounce-classification-domains--domain--entities--entity-id--rules","openApiOperationId":"GET-v1-bounce-classification-domains--domain--entities--entity-id--rules","summary":"List statistic per entity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-api-ListEntityStatsResp","exampleIds":["paths/~1v1~1bounce-classification~1domains~1{domain}~1entities~1{entity-id}~1rules/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-api-ListEntityStatsResp","exampleIds":["paths/~1v1~1bounce-classification~1domains~1{domain}~1entities~1{entity-id}~1rules/get/responses/200/content/application~1json/examples/Example"]},{"code":"403","description":"A 403 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1bounce-classification~1domains~1{domain}~1entities~1{entity-id}~1rules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-api-ListEntityStatsResp","exampleIds":["paths/~1v1~1bounce-classification~1domains~1{domain}~1entities~1{entity-id}~1rules/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-api-ListEntityStatsResp","exampleIds":["paths/~1v1~1bounce-classification~1domains~1{domain}~1entities~1{entity-id}~1rules/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bounce-classification/get-v1-bounce-classification-domains--domain--entities--entity-id--rules"}],"panels":[]}]},"httpPath":"/v1/bounce-classification/domains/{domain}/entities/{entity-id}/rules"},{"label":"List Bounce Logs","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/bounce-classification/get-v1-bounce-classification-domains--domain--events","routeSlug":"/docs/mailgun/api-reference/send/mailgun/bounce-classification/get-v1-bounce-classification-domains--domain--events","metadata":{"seo":{"title":"List Bounce Logs","description":"Deprecated: use POST /v1/analytics/logs - https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/logs"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-bounce-classification-domains--domain--events","name":"List Bounce Logs","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1bounce-classification~1domains~1{domain}~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Bounce Logs","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deprecated: use POST /v1/analytics/logs - https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/logs"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"components/schemas/string","description":"The sender domain name","required":true}],"pointer":"/paths/~1v1~1bounce-classification~1domains~1{domain}~1events/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rule-id","in":"query","schemaId":"components/schemas/string","description":"Optional if 'page' is passed"},{"name":"entity-id","in":"query","schemaId":"components/schemas/string","description":"The entity ID(Email Service Entity or Spam Filter / BL)"},{"name":"sort","in":"query","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field and order. Default is '@timestamp:asc'"},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"components/schemas/string","description":"Encoded paging information, provided via 'next', 'previous' links"},{"name":"limit","in":"query","schemaId":"schema_260","description":"Limits the number of items returned in a response"}],"pointer":"/paths/~1v1~1bounce-classification~1domains~1{domain}~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/bounce-classification/domains/{domain}/events","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"rule-id","in":"query","schemaId":"components/schemas/string"},{"name":"entity-id","in":"query","schemaId":"components/schemas/string"},{"name":"sort","in":"query","schemaId":"components/schemas/string"},{"name":"page","in":"query","schemaId":"components/schemas/string"},{"name":"limit","in":"query","schemaId":"schema_260"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["403","410"],"pointer":"/v1/bounce-classification/domains/{domain}/events","href":"bounce-classification/get-v1-bounce-classification-domains--domain--events","openApiOperationId":"GET-v1-bounce-classification-domains--domain--events","summary":"List Bounce Logs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"403","description":"A 403 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"410","description":"A 410 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1bounce-classification~1domains~1{domain}~1events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"403","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"410","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bounce-classification/get-v1-bounce-classification-domains--domain--events"}],"panels":[]}]},"httpPath":"/v1/bounce-classification/domains/{domain}/events"},{"label":"List entities","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/bounce-classification/get-v1-bounce-classification-config-entities","routeSlug":"/docs/mailgun/api-reference/send/mailgun/bounce-classification/get-v1-bounce-classification-config-entities","metadata":{"seo":{"title":"List entities","description":"Deprecated: use POST /v2/bounce-classification/metrics"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-bounce-classification-config-entities","name":"List entities","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1bounce-classification~1config~1entities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List entities","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deprecated: use POST /v2/bounce-classification/metrics"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/bounce-classification/config/entities","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/bounce-classification/config/entities","href":"bounce-classification/get-v1-bounce-classification-config-entities","openApiOperationId":"GET-v1-bounce-classification-config-entities","summary":"List entities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-config-Entities","exampleIds":["paths/~1v1~1bounce-classification~1config~1entities/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-config-Entities","exampleIds":["paths/~1v1~1bounce-classification~1config~1entities/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1bounce-classification~1config~1entities/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-config-Entities","exampleIds":["paths/~1v1~1bounce-classification~1config~1entities/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-config-Entities","exampleIds":["paths/~1v1~1bounce-classification~1config~1entities/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bounce-classification/get-v1-bounce-classification-config-entities"}],"panels":[]}]},"httpPath":"/v1/bounce-classification/config/entities"},{"label":"List rules","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/bounce-classification/get-v1-bounce-classification-config-rules","routeSlug":"/docs/mailgun/api-reference/send/mailgun/bounce-classification/get-v1-bounce-classification-config-rules","metadata":{"seo":{"title":"List rules","description":"Deprecated: use GET /v2/bounce-classification/config/groups/{group-id}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-bounce-classification-config-rules","name":"List rules","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1bounce-classification~1config~1rules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List rules","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated: use GET /v2/bounce-classification/config/groups/{group-id}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/bounce-classification/config/rules","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/bounce-classification/config/rules","href":"bounce-classification/get-v1-bounce-classification-config-rules","openApiOperationId":"GET-v1-bounce-classification-config-rules","summary":"List rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-config-Rules","exampleIds":["paths/~1v1~1bounce-classification~1config~1rules/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-config-Rules","exampleIds":["paths/~1v1~1bounce-classification~1config~1rules/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1bounce-classification~1config~1rules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-config-Rules","exampleIds":["paths/~1v1~1bounce-classification~1config~1rules/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-bounce-classification-internal-config-Rules","exampleIds":["paths/~1v1~1bounce-classification~1config~1rules/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bounce-classification/get-v1-bounce-classification-config-rules"}],"panels":[]}]},"httpPath":"/v1/bounce-classification/config/rules"}],"content":{"contentType":"group","meta":{"name":"Bounce Classification"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bounce Classification","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/bounce-classification/metrics","summary":"List statistic v2","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bounce-classification/post-v2-bounce-classification-metrics","deprecated":false},{"title":"/v1/bounce-classification/stats","summary":"List statistics, ordered by total bounces","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/bounce-classification/get-v1-bounce-classification-stats","deprecated":true},{"title":"/v1/bounce-classification/domains","summary":"List domains statistic per account","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/bounce-classification/get-v1-bounce-classification-domains","deprecated":true},{"title":"/v1/bounce-classification/domains/{domain}/entities","summary":"List statistic per domain","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/bounce-classification/get-v1-bounce-classification-domains--domain--entities","deprecated":true},{"title":"/v1/bounce-classification/domains/{domain}/entities/{entity-id}/rules","summary":"List statistic per entity","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/bounce-classification/get-v1-bounce-classification-domains--domain--entities--entity-id--rules","deprecated":true},{"title":"/v1/bounce-classification/domains/{domain}/events","summary":"List Bounce Logs","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/bounce-classification/get-v1-bounce-classification-domains--domain--events","deprecated":true},{"title":"/v1/bounce-classification/config/entities","summary":"List entities","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/bounce-classification/get-v1-bounce-classification-config-entities","deprecated":true},{"title":"/v1/bounce-classification/config/rules","summary":"List rules","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/bounce-classification/get-v1-bounce-classification-config-rules","deprecated":true}]}]}]}]}},{"type":"group","label":"Tags New","link":"/docs/mailgun/api-reference/send/mailgun/tags-new","routeSlug":"/docs/mailgun/api-reference/send/mailgun/tags-new","items":[{"label":"Update account tag","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/tags-new/put-v1-analytics-tags","routeSlug":"/docs/mailgun/api-reference/send/mailgun/tags-new/put-v1-analytics-tags","metadata":{"seo":{"title":"Update account tag","description":"Updates the tag description for an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v1-analytics-tags","name":"Update account tag","isWebhook":false,"pointer":"/paths/~1v1~1analytics~1tags/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update account tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the tag description for an account"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-UpdateTagRequest","exampleIds":["paths/~1v1~1analytics~1tags/put/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-UpdateTagRequest","exampleIds":["paths/~1v1~1analytics~1tags/put/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v1~1analytics~1tags/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/analytics/tags","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-UpdateTagRequest","exampleIds":["paths/~1v1~1analytics~1tags/put/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["200","400"],"pointer":"/v1/analytics/tags","href":"tags-new/put-v1-analytics-tags","openApiOperationId":"PUT-v1-analytics-tags","summary":"Update account tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-UpdateTagRequest","exampleIds":["paths/~1v1~1analytics~1tags/put/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-UpdateTagRequest","exampleIds":["paths/~1v1~1analytics~1tags/put/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1analytics~1tags/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1analytics~1tags/put/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1analytics~1tags/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1analytics~1tags/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1analytics~1tags/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags-new/put-v1-analytics-tags"}],"panels":[]}]},"httpPath":"/v1/analytics/tags"},{"label":"Post query to list account tags or search for single tag","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/tags-new/post-v1-analytics-tags","routeSlug":"/docs/mailgun/api-reference/send/mailgun/tags-new/post-v1-analytics-tags","metadata":{"seo":{"title":"Post query to list account tags or search for single tag","description":"Gets the list of all tags, or filtered by tag prefix, for an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v1-analytics-tags","name":"Post query to list account tags or search for single tag","isWebhook":false,"pointer":"/paths/~1v1~1analytics~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Post query to list account tags or search for single tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the list of all tags, or filtered by tag prefix, for an account"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-ListTagsRequest","exampleIds":["paths/~1v1~1analytics~1tags/post/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-ListTagsRequest","exampleIds":["paths/~1v1~1analytics~1tags/post/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v1~1analytics~1tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/analytics/tags","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-ListTagsRequest","exampleIds":["paths/~1v1~1analytics~1tags/post/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["200","400"],"pointer":"/v1/analytics/tags","href":"tags-new/post-v1-analytics-tags","openApiOperationId":"POST-v1-analytics-tags","summary":"Post query to list account tags or search for single tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-ListTagsRequest","exampleIds":["paths/~1v1~1analytics~1tags/post/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-ListTagsRequest","exampleIds":["paths/~1v1~1analytics~1tags/post/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-TagsResponse","exampleIds":["paths/~1v1~1analytics~1tags/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-TagsResponse","exampleIds":["paths/~1v1~1analytics~1tags/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1analytics~1tags/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1analytics~1tags/post/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1analytics~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-TagsResponse","exampleIds":["paths/~1v1~1analytics~1tags/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-TagsResponse","exampleIds":["paths/~1v1~1analytics~1tags/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1analytics~1tags/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1analytics~1tags/post/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags-new/post-v1-analytics-tags"}],"panels":[]}]},"httpPath":"/v1/analytics/tags"},{"label":"Delete account tag","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/tags-new/delete-v1-analytics-tags","routeSlug":"/docs/mailgun/api-reference/send/mailgun/tags-new/delete-v1-analytics-tags","metadata":{"seo":{"title":"Delete account tag","description":"Deletes the tag for an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v1-analytics-tags","name":"Delete account tag","isWebhook":false,"pointer":"/paths/~1v1~1analytics~1tags/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete account tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the tag for an account"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-DeleteTagRequest","exampleIds":["paths/~1v1~1analytics~1tags/delete/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-DeleteTagRequest","exampleIds":["paths/~1v1~1analytics~1tags/delete/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v1~1analytics~1tags/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/analytics/tags","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-DeleteTagRequest","exampleIds":["paths/~1v1~1analytics~1tags/delete/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["200","400"],"pointer":"/v1/analytics/tags","href":"tags-new/delete-v1-analytics-tags","openApiOperationId":"DELETE-v1-analytics-tags","summary":"Delete account tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-DeleteTagRequest","exampleIds":["paths/~1v1~1analytics~1tags/delete/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-DeleteTagRequest","exampleIds":["paths/~1v1~1analytics~1tags/delete/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1analytics~1tags/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1analytics~1tags/delete/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1analytics~1tags/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1analytics~1tags/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1analytics~1tags/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags-new/delete-v1-analytics-tags"}],"panels":[]}]},"httpPath":"/v1/analytics/tags"},{"label":"Get account tag limit information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/tags-new/get-v1-analytics-tags-limits","routeSlug":"/docs/mailgun/api-reference/send/mailgun/tags-new/get-v1-analytics-tags-limits","metadata":{"seo":{"title":"Get account tag limit information","description":"Gets the tag limit and current number of unique tags for an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-analytics-tags-limits","name":"Get account tag limit information","isWebhook":false,"pointer":"/paths/~1v1~1analytics~1tags~1limits/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get account tag limit information","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the tag limit and current number of unique tags for an account"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/analytics/tags/limits","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/analytics/tags/limits","href":"tags-new/get-v1-analytics-tags-limits","openApiOperationId":"GET-v1-analytics-tags-limits","summary":"Get account tag limit information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-TagLimitCountResponse"}},"schemaId":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-TagLimitCountResponse"},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1analytics~1tags~1limits/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-TagLimitCountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-TagLimitCountResponse"}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags-new/get-v1-analytics-tags-limits"}],"panels":[]}]},"httpPath":"/v1/analytics/tags/limits"}],"content":{"contentType":"group","meta":{"name":"Tags New"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tags New","showPageActions":true},{"nodeType":"markdoc","content":"Mailgun allows you to tag your email with unique identifiers. Tags are visible via our analytics tags API endpoint."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/analytics/tags","summary":"Update account tag","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tags-new/put-v1-analytics-tags","deprecated":false},{"title":"/v1/analytics/tags","summary":"Post query to list account tags or search for single tag","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags-new/post-v1-analytics-tags","deprecated":false},{"title":"/v1/analytics/tags","summary":"Delete account tag","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags-new/delete-v1-analytics-tags","deprecated":false},{"title":"/v1/analytics/tags/limits","summary":"Get account tag limit information","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tags-new/get-v1-analytics-tags-limits","deprecated":false}]}]}]}]}},{"type":"group","label":"Stats","link":"/docs/mailgun/api-reference/send/mailgun/stats","routeSlug":"/docs/mailgun/api-reference/send/mailgun/stats","items":[{"label":"Totals for entire account","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/stats/get-v3-stats-total","routeSlug":"/docs/mailgun/api-reference/send/mailgun/stats/get-v3-stats-total","metadata":{"seo":{"title":"Totals for entire account","description":"Gets stat totals for an entire account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-stats-total","name":"Totals for entire account","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v3~1stats~1total/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Totals for entire account","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets stat totals for an entire account"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"components/schemas/string","description":"The start date in RFC 2822 format or unix epoch (default: 7 days ago)"},{"name":"end","in":"query","schemaId":"components/schemas/string","description":"The end date in RFC 2822 format or unix epoch (default: current time) "},{"name":"resolution","in":"query","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The gregorian resolution the query is for 'day, month, hour` (default: day)"},"children":[]}]}]}]},{"name":"duration","in":"query","schemaId":"components/schemas/string","description":"If duration is provided than it's calculated from the 'end' date and overwrites the 'start' date"},{"name":"event","in":"query","schemaId":"components/schemas/string","description":"Name of the event(s) to receive the stats for (Multiple events are allowed). Supported events are: accepted, delivered, failed, opened, clicked, unsubscribed, complained, stored","required":true}],"pointer":"/paths/~1v3~1stats~1total/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/stats/total","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"start","in":"query","schemaId":"components/schemas/string"},{"name":"end","in":"query","schemaId":"components/schemas/string"},{"name":"resolution","in":"query","schemaId":"components/schemas/string"},{"name":"duration","in":"query","schemaId":"components/schemas/string"},{"name":"event","in":"query","required":true,"schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/stats/total","href":"stats/get-v3-stats-total","openApiOperationId":"GET-v3-stats-total","summary":"Totals for entire account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scout-api-StatsResponse","exampleIds":["paths/~1v3~1stats~1total/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scout-api-StatsResponse","exampleIds":["paths/~1v3~1stats~1total/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1stats~1total/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1stats~1total/get/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1stats~1total/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scout-api-StatsResponse","exampleIds":["paths/~1v3~1stats~1total/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scout-api-StatsResponse","exampleIds":["paths/~1v3~1stats~1total/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1stats~1total/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1stats~1total/get/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stats/get-v3-stats-total"}],"panels":[]}]},"httpPath":"/v3/stats/total"},{"label":"Totals for entire domain","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/stats/get-v3--domain--stats-total","routeSlug":"/docs/mailgun/api-reference/send/mailgun/stats/get-v3--domain--stats-total","metadata":{"seo":{"title":"Totals for entire domain","description":"Gets stat totals for an entire domain"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3--domain--stats-total","name":"Totals for entire domain","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v3~1{domain}~1stats~1total/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Totals for entire domain","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets stat totals for an entire domain"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"components/schemas/string","description":"The domain name","required":true}],"pointer":"/paths/~1v3~1{domain}~1stats~1total/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"components/schemas/string","description":"The start date in RFC 2822 format or unix epoch (default: 7 days ago)"},{"name":"end","in":"query","schemaId":"components/schemas/string","description":"The end date in RFC 2822 format or unix epoch (default: current time) "},{"name":"resolution","in":"query","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The gregorian resolution the query is for 'day, month, hour` (default: day)"},"children":[]}]}]}]},{"name":"duration","in":"query","schemaId":"components/schemas/string","description":"If duration is provided than it's calculated from the 'end' date and overwrites the 'start' date"},{"name":"event","in":"query","schemaId":"components/schemas/string","description":"Name of the event(s) to receive the stats for (Multiple events are allowed). Supported events are: accepted, delivered, failed, opened, clicked, unsubscribed, complained, stored","required":true}],"pointer":"/paths/~1v3~1{domain}~1stats~1total/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/{domain}/stats/total","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"start","in":"query","schemaId":"components/schemas/string"},{"name":"end","in":"query","schemaId":"components/schemas/string"},{"name":"resolution","in":"query","schemaId":"components/schemas/string"},{"name":"duration","in":"query","schemaId":"components/schemas/string"},{"name":"event","in":"query","required":true,"schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/{domain}/stats/total","href":"stats/get-v3--domain--stats-total","openApiOperationId":"GET-v3--domain--stats-total","summary":"Totals for entire domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scout-api-StatsResponse","exampleIds":["paths/~1v3~1{domain}~1stats~1total/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scout-api-StatsResponse","exampleIds":["paths/~1v3~1{domain}~1stats~1total/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1stats~1total/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1stats~1total/get/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain}~1stats~1total/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scout-api-StatsResponse","exampleIds":["paths/~1v3~1{domain}~1stats~1total/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scout-api-StatsResponse","exampleIds":["paths/~1v3~1{domain}~1stats~1total/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1stats~1total/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1stats~1total/get/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stats/get-v3--domain--stats-total"}],"panels":[]}]},"httpPath":"/v3/{domain}/stats/total"},{"label":"Totals for account domains for a single time resolution","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/stats/get-v3-stats-total-domains","routeSlug":"/docs/mailgun/api-reference/send/mailgun/stats/get-v3-stats-total-domains","metadata":{"seo":{"title":"Totals for account domains for a single time resolution","description":"Gets stat totals for domains in an account for a single time resolution"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-stats-total-domains","name":"Totals for account domains for a single time resolution","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v3~1stats~1total~1domains/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Totals for account domains for a single time resolution","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets stat  totals for domains in an account for a single time resolution"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"event","in":"query","schemaId":"components/schemas/string","description":"Name of the event(s) to receive the stats for (Multiple events are allowed). Supported events are: accepted, delivered, failed, opened, clicked, unsubscribed, complained, stored","required":true},{"name":"limit","in":"query","schemaId":"components/schemas/string","description":"Skip x number of domains; used to page through large numbers of domains"},{"name":"resolution","in":"query","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The gregorian resolution the query is for 'day, month, hour` (default: day)"},"children":[]}]}]}]},{"name":"timestamp","in":"query","schemaId":"components/schemas/string","description":"The date/time of the 'resolution' we are retrieving","required":true}],"pointer":"/paths/~1v3~1stats~1total~1domains/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/stats/total/domains","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"event","in":"query","required":true,"schemaId":"components/schemas/string"},{"name":"limit","in":"query","schemaId":"components/schemas/string"},{"name":"resolution","in":"query","schemaId":"components/schemas/string"},{"name":"timestamp","in":"query","required":true,"schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/stats/total/domains","href":"stats/get-v3-stats-total-domains","openApiOperationId":"GET-v3-stats-total-domains","summary":"Totals for account domains for a single time resolution"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scout-api-StatsResponse","exampleIds":["paths/~1v3~1stats~1total~1domains/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scout-api-StatsResponse","exampleIds":["paths/~1v3~1stats~1total~1domains/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1stats~1total~1domains/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1stats~1total~1domains/get/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1stats~1total~1domains/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scout-api-StatsResponse","exampleIds":["paths/~1v3~1stats~1total~1domains/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scout-api-StatsResponse","exampleIds":["paths/~1v3~1stats~1total~1domains/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1stats~1total~1domains/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1stats~1total~1domains/get/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stats/get-v3-stats-total-domains"}],"panels":[]}]},"httpPath":"/v3/stats/total/domains"},{"label":"Filtered/grouped totals for entire account","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/stats/get-v3-stats-filter","routeSlug":"/docs/mailgun/api-reference/send/mailgun/stats/get-v3-stats-filter","metadata":{"seo":{"title":"Filtered/grouped totals for entire account","description":"Gets filtered and group stat totals for an entire account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-stats-filter","name":"Filtered/grouped totals for entire account","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v3~1stats~1filter/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Filtered/grouped totals for entire account","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets filtered and group stat totals for an entire account"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"components/schemas/string","description":"The start date in RFC 2822 format or unix epoch (default: 7 days ago)"},{"name":"end","in":"query","schemaId":"components/schemas/string","description":"The end date in RFC 2822 format or unix epoch (default: current time) "},{"name":"resolution","in":"query","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The gregorian resolution the query is for 'day, month, hour` (default: day)"},"children":[]}]}]}]},{"name":"duration","in":"query","schemaId":"components/schemas/string","description":"If duration is provided than it's calculated from the 'end' date and overwrites the 'start' date"},{"name":"event","in":"query","schemaId":"components/schemas/string","description":"Name of the event(s) to receive the stats for (Multiple events are allowed). Supported events are: accepted, delivered, failed, opened, clicked, unsubscribed, complained, stored","required":true},{"name":"filter","in":"query","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A filter for account level metrics such as filter=domain:my.example.com"},"children":[]}]}]}]},{"name":"group","in":"query","schemaId":"components/schemas/string","description":"The key to group metrics by.  Must be one of total, time, day, month, domain, ip, provider, tag, country"}],"pointer":"/paths/~1v3~1stats~1filter/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/stats/filter","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"start","in":"query","schemaId":"components/schemas/string"},{"name":"end","in":"query","schemaId":"components/schemas/string"},{"name":"resolution","in":"query","schemaId":"components/schemas/string"},{"name":"duration","in":"query","schemaId":"components/schemas/string"},{"name":"event","in":"query","required":true,"schemaId":"components/schemas/string"},{"name":"filter","in":"query","schemaId":"components/schemas/string"},{"name":"group","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/stats/filter","href":"stats/get-v3-stats-filter","openApiOperationId":"GET-v3-stats-filter","summary":"Filtered/grouped totals for entire account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scout-api-StatsResponse","exampleIds":["paths/~1v3~1stats~1filter/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scout-api-StatsResponse","exampleIds":["paths/~1v3~1stats~1filter/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1stats~1filter/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1stats~1filter/get/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1stats~1filter/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scout-api-StatsResponse","exampleIds":["paths/~1v3~1stats~1filter/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scout-api-StatsResponse","exampleIds":["paths/~1v3~1stats~1filter/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1stats~1filter/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1stats~1filter/get/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stats/get-v3-stats-filter"}],"panels":[]}]},"httpPath":"/v3/stats/filter"},{"label":"Aggregate counts by ESP","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/stats/get-v3--domain--aggregates-providers","routeSlug":"/docs/mailgun/api-reference/send/mailgun/stats/get-v3--domain--aggregates-providers","metadata":{"seo":{"title":"Aggregate counts by ESP","description":"Gets aggregate counts by email service provider"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3--domain--aggregates-providers","name":"Aggregate counts by ESP","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v3~1{domain}~1aggregates~1providers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Aggregate counts by ESP","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets aggregate counts by email service provider"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"components/schemas/string","description":"The domain name","required":true}],"pointer":"/paths/~1v3~1{domain}~1aggregates~1providers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/{domain}/aggregates/providers","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/{domain}/aggregates/providers","href":"stats/get-v3--domain--aggregates-providers","openApiOperationId":"GET-v3--domain--aggregates-providers","summary":"Aggregate counts by ESP"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scout-api-ProvidersAggregateResponse","exampleIds":["paths/~1v3~1{domain}~1aggregates~1providers/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scout-api-ProvidersAggregateResponse","exampleIds":["paths/~1v3~1{domain}~1aggregates~1providers/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1aggregates~1providers/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1aggregates~1providers/get/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain}~1aggregates~1providers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scout-api-ProvidersAggregateResponse","exampleIds":["paths/~1v3~1{domain}~1aggregates~1providers/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scout-api-ProvidersAggregateResponse","exampleIds":["paths/~1v3~1{domain}~1aggregates~1providers/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1aggregates~1providers/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1aggregates~1providers/get/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stats/get-v3--domain--aggregates-providers"}],"panels":[]}]},"httpPath":"/v3/{domain}/aggregates/providers"},{"label":"Aggregate counts by devices triggering events ","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/stats/get-v3--domain--aggregates-devices","routeSlug":"/docs/mailgun/api-reference/send/mailgun/stats/get-v3--domain--aggregates-devices","metadata":{"seo":{"title":"Aggregate counts by devices triggering events ","description":"Gets  aggregate counts on devices that triggered events ('tablet', 'phone', 'pc', etc…)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3--domain--aggregates-devices","name":"Aggregate counts by devices triggering events ","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v3~1{domain}~1aggregates~1devices/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Aggregate counts by devices triggering events ","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets  aggregate counts on devices that triggered events ('tablet', 'phone', 'pc', etc…)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"components/schemas/string","description":"The domain name","required":true}],"pointer":"/paths/~1v3~1{domain}~1aggregates~1devices/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/{domain}/aggregates/devices","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/{domain}/aggregates/devices","href":"stats/get-v3--domain--aggregates-devices","openApiOperationId":"GET-v3--domain--aggregates-devices","summary":"Aggregate counts by devices triggering events "},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scout-api-DevicesAggregateResponse","exampleIds":["paths/~1v3~1{domain}~1aggregates~1devices/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scout-api-DevicesAggregateResponse","exampleIds":["paths/~1v3~1{domain}~1aggregates~1devices/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1aggregates~1devices/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1aggregates~1devices/get/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain}~1aggregates~1devices/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scout-api-DevicesAggregateResponse","exampleIds":["paths/~1v3~1{domain}~1aggregates~1devices/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scout-api-DevicesAggregateResponse","exampleIds":["paths/~1v3~1{domain}~1aggregates~1devices/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1aggregates~1devices/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1aggregates~1devices/get/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stats/get-v3--domain--aggregates-devices"}],"panels":[]}]},"httpPath":"/v3/{domain}/aggregates/devices"},{"label":"Aggregate counts by country","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/stats/get-v3--domain--aggregates-countries","routeSlug":"/docs/mailgun/api-reference/send/mailgun/stats/get-v3--domain--aggregates-countries","metadata":{"seo":{"title":"Aggregate counts by country","description":"Gets aggregate counts by country (USA, RUS, etc…)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3--domain--aggregates-countries","name":"Aggregate counts by country","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v3~1{domain}~1aggregates~1countries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Aggregate counts by country","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets aggregate counts by country (USA, RUS, etc…)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"components/schemas/string","description":"The domain name","required":true}],"pointer":"/paths/~1v3~1{domain}~1aggregates~1countries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/{domain}/aggregates/countries","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/{domain}/aggregates/countries","href":"stats/get-v3--domain--aggregates-countries","openApiOperationId":"GET-v3--domain--aggregates-countries","summary":"Aggregate counts by country"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scout-api-CountriesAggregateResponse","exampleIds":["paths/~1v3~1{domain}~1aggregates~1countries/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scout-api-CountriesAggregateResponse","exampleIds":["paths/~1v3~1{domain}~1aggregates~1countries/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1aggregates~1countries/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1aggregates~1countries/get/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain}~1aggregates~1countries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scout-api-CountriesAggregateResponse","exampleIds":["paths/~1v3~1{domain}~1aggregates~1countries/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scout-api-CountriesAggregateResponse","exampleIds":["paths/~1v3~1{domain}~1aggregates~1countries/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1aggregates~1countries/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1aggregates~1countries/get/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stats/get-v3--domain--aggregates-countries"}],"panels":[]}]},"httpPath":"/v3/{domain}/aggregates/countries"}],"content":{"contentType":"group","meta":{"name":"Stats"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stats","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mailgun collects many different events and generates event statistics which are available in your Control Panel. This data is also available via our stats API endpoint."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARNING:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"i","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This API is deprecated in favor of our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/metrics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API. "},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/stats/total","summary":"Totals for entire account","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/stats/get-v3-stats-total","deprecated":true},{"title":"/v3/{domain}/stats/total","summary":"Totals for entire domain","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/stats/get-v3--domain--stats-total","deprecated":true},{"title":"/v3/stats/total/domains","summary":"Totals for account domains for a single time resolution","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/stats/get-v3-stats-total-domains","deprecated":true},{"title":"/v3/stats/filter","summary":"Filtered/grouped totals for entire account","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/stats/get-v3-stats-filter","deprecated":true},{"title":"/v3/{domain}/aggregates/providers","summary":"Aggregate counts by ESP","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/stats/get-v3--domain--aggregates-providers","deprecated":true},{"title":"/v3/{domain}/aggregates/devices","summary":"Aggregate counts by devices triggering events ","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/stats/get-v3--domain--aggregates-devices","deprecated":true},{"title":"/v3/{domain}/aggregates/countries","summary":"Aggregate counts by country","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/stats/get-v3--domain--aggregates-countries","deprecated":true}]}]}]}]}},{"type":"group","label":"Tags","link":"/docs/mailgun/api-reference/send/mailgun/tags","routeSlug":"/docs/mailgun/api-reference/send/mailgun/tags","items":[{"label":"List all tags","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/tags/get-v3--domain--tags","routeSlug":"/docs/mailgun/api-reference/send/mailgun/tags/get-v3--domain--tags","metadata":{"seo":{"title":"List all tags","description":"List all tags associated with a domain"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3--domain--tags","name":"List all tags","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v3~1{domain}~1tags/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all tags","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all tags associated with a domain"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"components/schemas/string","description":"The domain name","required":true}],"pointer":"/paths/~1v3~1{domain}~1tags/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"components/schemas/string","description":"The page direction based on the tag parameter; valid choices are (first, last, next, prev)"},{"name":"limit","in":"query","schemaId":"schema_260","description":"Limits the number of items returned in a request"},{"name":"tag","in":"query","schemaId":"components/schemas/string","description":"The tag that marks the end of the current page and the start of the next"},{"name":"prefix","in":"query","schemaId":"components/schemas/string","description":"List only tags that begin with this prefix"}],"pointer":"/paths/~1v3~1{domain}~1tags/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/{domain}/tags","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"page","in":"query","schemaId":"components/schemas/string"},{"name":"limit","in":"query","schemaId":"schema_260"},{"name":"tag","in":"query","schemaId":"components/schemas/string"},{"name":"prefix","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/{domain}/tags","href":"tags/get-v3--domain--tags","openApiOperationId":"GET-v3--domain--tags","summary":"List all tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scout-api-TagListResponse","exampleIds":["paths/~1v3~1{domain}~1tags/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scout-api-TagListResponse","exampleIds":["paths/~1v3~1{domain}~1tags/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tags/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tags/get/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain}~1tags/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scout-api-TagListResponse","exampleIds":["paths/~1v3~1{domain}~1tags/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scout-api-TagListResponse","exampleIds":["paths/~1v3~1{domain}~1tags/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tags/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tags/get/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/get-v3--domain--tags"}],"panels":[]}]},"httpPath":"/v3/{domain}/tags"},{"label":"Get a tag","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/tags/get-v3--domain--tag","routeSlug":"/docs/mailgun/api-reference/send/mailgun/tags/get-v3--domain--tag","metadata":{"seo":{"title":"Get a tag","description":"Get a tag associated with a domain"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3--domain--tag","name":"Get a tag","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v3~1{domain}~1tag/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a tag","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a tag associated with a domain"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"components/schemas/string","description":"The domain name","required":true}],"pointer":"/paths/~1v3~1{domain}~1tag/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"tag","in":"query","schemaId":"components/schemas/string","description":"The name of the tag","required":true}],"pointer":"/paths/~1v3~1{domain}~1tag/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/{domain}/tag","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"tag","in":"query","required":true,"schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/{domain}/tag","href":"tags/get-v3--domain--tag","openApiOperationId":"GET-v3--domain--tag","summary":"Get a tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scout-model-tags-TagItem","exampleIds":["paths/~1v3~1{domain}~1tag/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scout-model-tags-TagItem","exampleIds":["paths/~1v3~1{domain}~1tag/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag/get/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain}~1tag/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scout-model-tags-TagItem","exampleIds":["paths/~1v3~1{domain}~1tag/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scout-model-tags-TagItem","exampleIds":["paths/~1v3~1{domain}~1tag/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag/get/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/get-v3--domain--tag"}],"panels":[]}]},"httpPath":"/v3/{domain}/tag"},{"label":"Update tag ","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/tags/put-v3--domain--tag","routeSlug":"/docs/mailgun/api-reference/send/mailgun/tags/put-v3--domain--tag","metadata":{"seo":{"title":"Update tag ","description":"Update a tag associated with a domain"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v3--domain--tag","name":"Update tag ","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v3~1{domain}~1tag/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update tag ","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a tag associated with a domain"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"components/schemas/string","description":"The domain id","required":true}],"pointer":"/paths/~1v3~1{domain}~1tag/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"tag","in":"query","schemaId":"components/schemas/string","description":"The name of the tag","required":true},{"name":"description","in":"query","schemaId":"components/schemas/string","description":"The description of the tag"}],"pointer":"/paths/~1v3~1{domain}~1tag/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/{domain}/tag","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"tag","in":"query","required":true,"schemaId":"components/schemas/string"},{"name":"description","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/{domain}/tag","href":"tags/put-v3--domain--tag","openApiOperationId":"PUT-v3--domain--tag","summary":"Update tag "},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag/put/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag/put/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag/put/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain}~1tag/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag/put/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag/put/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/put-v3--domain--tag"}],"panels":[]}]},"httpPath":"/v3/{domain}/tag"},{"label":"Delete tag","deprecated":true,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/tags/delete-v3--domain--tag","routeSlug":"/docs/mailgun/api-reference/send/mailgun/tags/delete-v3--domain--tag","metadata":{"seo":{"title":"Delete tag","description":"Delete a tag associated with a domain"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3--domain--tag","name":"Delete tag","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v3~1{domain}~1tag/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete tag","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a tag associated with a domain"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"components/schemas/string","description":"The domain name","required":true}],"pointer":"/paths/~1v3~1{domain}~1tag/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"tag","in":"query","schemaId":"components/schemas/string","description":"The name of the tag"}],"pointer":"/paths/~1v3~1{domain}~1tag/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/{domain}/tag","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"tag","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/{domain}/tag","href":"tags/delete-v3--domain--tag","openApiOperationId":"DELETE-v3--domain--tag","summary":"Delete tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag/delete/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag/delete/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag/delete/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain}~1tag/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag/delete/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag/delete/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/delete-v3--domain--tag"}],"panels":[]}]},"httpPath":"/v3/{domain}/tag"},{"label":"Get aggregate stat types by tag","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/tags/get-v3--domain--tag-stats-aggregates","routeSlug":"/docs/mailgun/api-reference/send/mailgun/tags/get-v3--domain--tag-stats-aggregates","metadata":{"seo":{"title":"Get aggregate stat types by tag","description":"Returns a list for a given domain for different event types"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3--domain--tag-stats-aggregates","name":"Get aggregate stat types by tag","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v3~1{domain}~1tag~1stats~1aggregates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get aggregate stat types by tag","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list  for a given domain for different event types"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"components/schemas/string","description":"The domain name","required":true}],"pointer":"/paths/~1v3~1{domain}~1tag~1stats~1aggregates/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"tag","in":"query","schemaId":"components/schemas/string","description":"The name of the tag","required":true},{"name":"type","in":"query","schemaId":"components/schemas/string","description":"The type of aggregate (country, device, provider)","required":true}],"pointer":"/paths/~1v3~1{domain}~1tag~1stats~1aggregates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/{domain}/tag/stats/aggregates","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"tag","in":"query","required":true,"schemaId":"components/schemas/string"},{"name":"type","in":"query","required":true,"schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/{domain}/tag/stats/aggregates","href":"tags/get-v3--domain--tag-stats-aggregates","openApiOperationId":"GET-v3--domain--tag-stats-aggregates","summary":"Get aggregate stat types by tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scout-api-TagAggregateResponse","exampleIds":["paths/~1v3~1{domain}~1tag~1stats~1aggregates/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scout-api-TagAggregateResponse","exampleIds":["paths/~1v3~1{domain}~1tag~1stats~1aggregates/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag~1stats~1aggregates/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag~1stats~1aggregates/get/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain}~1tag~1stats~1aggregates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scout-api-TagAggregateResponse","exampleIds":["paths/~1v3~1{domain}~1tag~1stats~1aggregates/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scout-api-TagAggregateResponse","exampleIds":["paths/~1v3~1{domain}~1tag~1stats~1aggregates/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag~1stats~1aggregates/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag~1stats~1aggregates/get/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/get-v3--domain--tag-stats-aggregates"}],"panels":[]}]},"httpPath":"/v3/{domain}/tag/stats/aggregates"},{"label":"Get stats by tag","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/tags/get-v3--domain--tag-stats","routeSlug":"/docs/mailgun/api-reference/send/mailgun/tags/get-v3--domain--tag-stats","metadata":{"seo":{"title":"Get stats by tag","description":"Retrieve stats by tag"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3--domain--tag-stats","name":"Get stats by tag","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v3~1{domain}~1tag~1stats/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get stats by tag","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve stats by tag"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"components/schemas/string","description":"The domain id","required":true}],"pointer":"/paths/~1v3~1{domain}~1tag~1stats/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"components/schemas/string","description":"The start date in RFC 2822 format or unix epoch (default: 7 days ago)"},{"name":"end","in":"query","schemaId":"components/schemas/string","description":"The end date in RFC 2822 format or unix epoch (default: current time) "},{"name":"resolution","in":"query","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The gregorian resolution the query is for 'day, month, hour` (default: day)"},"children":[]}]}]}]},{"name":"duration","in":"query","schemaId":"components/schemas/string","description":"If duration is provided than it's calculated from the 'end' date and overwrites the 'start' date"},{"name":"provider","in":"query","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The provider value; see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v3/domains/1/tag/providers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for possible values"},"children":[]}]}]}]},{"name":"device","in":"query","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The device value; see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v3/domains/1/tag/devices"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for possible values"},"children":[]}]}]}]},{"name":"country","in":"query","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country value; see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v3/domains/1/tag/providers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for possible values"},"children":[]}]}]}]},{"name":"event","in":"query","schemaId":"components/schemas/string","description":"Name of the event(s) to receive the stats for (Multiple events are allowed). Supported events are: accepted, delivered, failed, opened, clicked, unsubscribed, complained, stored","required":true},{"name":"tag","in":"query","schemaId":"components/schemas/string","description":"The name of the tag","required":true}],"pointer":"/paths/~1v3~1{domain}~1tag~1stats/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/{domain}/tag/stats","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"start","in":"query","schemaId":"components/schemas/string"},{"name":"end","in":"query","schemaId":"components/schemas/string"},{"name":"resolution","in":"query","schemaId":"components/schemas/string"},{"name":"duration","in":"query","schemaId":"components/schemas/string"},{"name":"provider","in":"query","schemaId":"components/schemas/string"},{"name":"device","in":"query","schemaId":"components/schemas/string"},{"name":"country","in":"query","schemaId":"components/schemas/string"},{"name":"event","in":"query","required":true,"schemaId":"components/schemas/string"},{"name":"tag","in":"query","required":true,"schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/{domain}/tag/stats","href":"tags/get-v3--domain--tag-stats","openApiOperationId":"GET-v3--domain--tag-stats","summary":"Get stats by tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scout-api-StatsResponse","exampleIds":["paths/~1v3~1{domain}~1tag~1stats/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scout-api-StatsResponse","exampleIds":["paths/~1v3~1{domain}~1tag~1stats/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag~1stats/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag~1stats/get/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain}~1tag~1stats/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scout-api-StatsResponse","exampleIds":["paths/~1v3~1{domain}~1tag~1stats/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scout-api-StatsResponse","exampleIds":["paths/~1v3~1{domain}~1tag~1stats/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag~1stats/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain}~1tag~1stats/get/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/get-v3--domain--tag-stats"}],"panels":[]}]},"httpPath":"/v3/{domain}/tag/stats"},{"label":"Get tag limits","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/tags/get-v3-domains--domain--limits-tag","routeSlug":"/docs/mailgun/api-reference/send/mailgun/tags/get-v3-domains--domain--limits-tag","metadata":{"seo":{"title":"Get tag limits","description":"Get tag limits by domain"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-domains--domain--limits-tag","name":"Get tag limits","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v3~1domains~1{domain}~1limits~1tag/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get tag limits","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get tag limits by domain"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"components/schemas/string","description":"The domain name","required":true}],"pointer":"/paths/~1v3~1domains~1{domain}~1limits~1tag/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/domains/{domain}/limits/tag","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/domains/{domain}/limits/tag","href":"tags/get-v3-domains--domain--limits-tag","openApiOperationId":"GET-v3-domains--domain--limits-tag","summary":"Get tag limits"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scout-model-types-TagLimitItem","exampleIds":["paths/~1v3~1domains~1{domain}~1limits~1tag/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scout-model-types-TagLimitItem","exampleIds":["paths/~1v3~1domains~1{domain}~1limits~1tag/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain}~1limits~1tag/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain}~1limits~1tag/get/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{domain}~1limits~1tag/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scout-model-types-TagLimitItem","exampleIds":["paths/~1v3~1domains~1{domain}~1limits~1tag/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scout-model-types-TagLimitItem","exampleIds":["paths/~1v3~1domains~1{domain}~1limits~1tag/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain}~1limits~1tag/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain}~1limits~1tag/get/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/get-v3-domains--domain--limits-tag"}],"panels":[]}]},"httpPath":"/v3/domains/{domain}/limits/tag"}],"content":{"contentType":"group","meta":{"name":"Tags"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tags","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mailgun lets you tag each outgoing message with a custom value. When you access stats on your messages, they will be aggregated by these tags."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARNING:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"i","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This API is deprecated in favor of our new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/tags-new"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API. "},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/{domain}/tags","summary":"List all tags","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/tags/get-v3--domain--tags","deprecated":true},{"title":"/v3/{domain}/tag","summary":"Get a tag","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/tags/get-v3--domain--tag","deprecated":true},{"title":"/v3/{domain}/tag","summary":"Update tag ","prefix":{"name":"put","color":"http-deprecated"},"badges":[],"link":"/tags/put-v3--domain--tag","deprecated":true},{"title":"/v3/{domain}/tag","summary":"Delete tag","prefix":{"name":"delete","color":"http-deprecated"},"badges":[],"link":"/tags/delete-v3--domain--tag","deprecated":true},{"title":"/v3/{domain}/tag/stats/aggregates","summary":"Get aggregate stat types by tag","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/tags/get-v3--domain--tag-stats-aggregates","deprecated":true},{"title":"/v3/{domain}/tag/stats","summary":"Get stats by tag","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/tags/get-v3--domain--tag-stats","deprecated":true},{"title":"/v3/domains/{domain}/limits/tag","summary":"Get tag limits","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/tags/get-v3-domains--domain--limits-tag","deprecated":true}]}]}]}]}},{"type":"group","label":"Events","link":"/docs/mailgun/api-reference/send/mailgun/events","routeSlug":"/docs/mailgun/api-reference/send/mailgun/events","items":[{"label":"Retrieves a paginated list of events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/events/get-v3-domain_name-events","routeSlug":"/docs/mailgun/api-reference/send/mailgun/events/get-v3-domain_name-events","metadata":{"seo":{"title":"Retrieves a paginated list of events","description":"Mailgun tracks every inbound and outbound message event and retains this data for at least 3 days.See Filter expression for details about filtering expressions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-v3-domain_name-events","name":"Retrieves a paginated list of events","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a paginated list of events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mailgun tracks every inbound and outbound message event and retains this data for at least 3 days."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/events/#filter-expression"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter expression"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details about filtering expressions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Filter by sending domain","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1events/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"begin","in":"query","schemaId":"components/schemas/string","description":"The beginning of the search time range in epoch seconds"},{"name":"end","in":"query","schemaId":"components/schemas/string","description":"The end of the search time range in epoch seconds"},{"name":"ascending","in":"query","schemaId":"schema_265","description":"Sort direction by time. Must be provided if the range end time is not specified. Can be either yes or no"},{"name":"limit","in":"query","schemaId":"schema_266","description":"The number of entries to return (300 max)"},{"name":"event","in":"query","schemaId":"components/schemas/string","description":"Filter by event type"},{"name":"list","in":"query","schemaId":"components/schemas/string","description":"Filter by mailing list email address that message was originally sent to"},{"name":"attachment","in":"query","schemaId":"components/schemas/string","description":"Filter by the name of an attached file"},{"name":"from","in":"query","schemaId":"components/schemas/string","description":"Filter by email address mentioned in the From MIME header"},{"name":"message-id","in":"query","schemaId":"components/schemas/string","description":"Filter by Mailgun message id returned by the messages API"},{"name":"subject","in":"query","schemaId":"components/schemas/string","description":"Filter by subject line"},{"name":"to","in":"query","schemaId":"components/schemas/string","description":"Filter by email address mentioned in the To MIME header"},{"name":"size","in":"query","schemaId":"components/schemas/string","description":"Filter by message size. Mostly intended to be used with range filtering expressions"},{"name":"recipient","in":"query","schemaId":"components/schemas/string","description":"Filter by email address of a recipient. While messages are addressable to one or more recipients, each event (with one exception) tracks one recipient. See stored events for use of recipients"},{"name":"recipients","in":"query","schemaId":"components/schemas/string","description":"Specific to stored events, this field tracks all of the potential message recipients."},{"name":"tags","in":"query","schemaId":"components/schemas/string","description":"Filter by user defined tags"},{"name":"severity","in":"query","schemaId":"schema_267","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by event severity, if exists. Currently for failed events only. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/tracking-messages/#tracking-failures"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking Failures"},"children":[]}]}]}]}]}],"pointer":"/paths/~1v3~1{domain_name}~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/{domain_name}/events","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"begin","in":"query","schemaId":"components/schemas/string"},{"name":"end","in":"query","schemaId":"components/schemas/string"},{"name":"ascending","in":"query","schemaId":"schema_265"},{"name":"limit","in":"query","schemaId":"schema_266"},{"name":"event","in":"query","schemaId":"components/schemas/string"},{"name":"list","in":"query","schemaId":"components/schemas/string"},{"name":"attachment","in":"query","schemaId":"components/schemas/string"},{"name":"from","in":"query","schemaId":"components/schemas/string"},{"name":"message-id","in":"query","schemaId":"components/schemas/string"},{"name":"subject","in":"query","schemaId":"components/schemas/string"},{"name":"to","in":"query","schemaId":"components/schemas/string"},{"name":"size","in":"query","schemaId":"components/schemas/string"},{"name":"recipient","in":"query","schemaId":"components/schemas/string"},{"name":"recipients","in":"query","schemaId":"components/schemas/string"},{"name":"tags","in":"query","schemaId":"components/schemas/string"},{"name":"severity","in":"query","schemaId":"components/schemas/EventSeverityType"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/{domain_name}/events","href":"events/get-v3-domain_name-events","openApiOperationId":"get-v3-domain_name-events","summary":"Retrieves a paginated list of events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_268","exampleIds":["paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Rejected","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Stored","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Complained","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Unsubscribed","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Clicked","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Opened","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Failed","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Delivered","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Accepted"]}},"schemaId":"schema_268","exampleIds":["paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Rejected","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Stored","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Complained","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Unsubscribed","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Clicked","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Opened","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Failed","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Delivered","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Accepted"]}],"pointer":"/paths/~1v3~1{domain_name}~1events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_268","exampleIds":["paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Rejected","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Stored","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Complained","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Unsubscribed","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Clicked","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Opened","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Failed","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Delivered","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Accepted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_268","exampleIds":["paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Rejected","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Stored","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Complained","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Unsubscribed","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Clicked","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Opened","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Failed","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Delivered","paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Accepted"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/get-v3-domain_name-events"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/events"}],"content":{"contentType":"group","meta":{"name":"Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Events","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mailgun keeps track of every inbound and outbound message event and stores this data for at least 3 days."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARNING:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"i","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This API is deprecated in favor of our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/logs"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Logs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API. "},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/{domain_name}/events","summary":"Retrieves a paginated list of events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/get-v3-domain_name-events","deprecated":false}]}]}]}]}},{"type":"separator","label":"Send Alerts","content":null},{"type":"group","label":"Send Alerts","link":"/docs/mailgun/api-reference/send/mailgun/send-alerts","routeSlug":"/docs/mailgun/api-reference/send/mailgun/send-alerts","items":[{"label":"List send alerts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/send-alerts/get-v1-thresholds-alerts-send","routeSlug":"/docs/mailgun/api-reference/send/mailgun/send-alerts/get-v1-thresholds-alerts-send","metadata":{"seo":{"title":"List send alerts","description":"List send alerts"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-thresholds-alerts-send","name":"List send alerts","isWebhook":false,"pointer":"/paths/~1v1~1thresholds~1alerts~1send/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List send alerts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/thresholds/alerts/send","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/thresholds/alerts/send","href":"send-alerts/get-v1-thresholds-alerts-send","openApiOperationId":"GET-v1-thresholds-alerts-send","summary":"List send alerts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-SendAlertListResponse","exampleIds":["paths/~1v1~1thresholds~1alerts~1send/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-thresholds-api-SendAlertListResponse","exampleIds":["paths/~1v1~1thresholds~1alerts~1send/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1thresholds~1alerts~1send/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-thresholds-api-SendAlertListResponse","exampleIds":["paths/~1v1~1thresholds~1alerts~1send/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-SendAlertListResponse","exampleIds":["paths/~1v1~1thresholds~1alerts~1send/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/send-alerts/get-v1-thresholds-alerts-send"}],"panels":[]}]},"httpPath":"/v1/thresholds/alerts/send"},{"label":"Create a send alert for an account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/send-alerts/post-v1-thresholds-alerts-send","routeSlug":"/docs/mailgun/api-reference/send/mailgun/send-alerts/post-v1-thresholds-alerts-send","metadata":{"seo":{"title":"Create a send alert for an account","description":"Create a send alert for an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v1-thresholds-alerts-send","name":"Create a send alert for an account","isWebhook":false,"pointer":"/paths/~1v1~1thresholds~1alerts~1send/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a send alert for an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-SendAlertRequest","exampleIds":["paths/~1v1~1thresholds~1alerts~1send/post/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-thresholds-api-SendAlertRequest","exampleIds":["paths/~1v1~1thresholds~1alerts~1send/post/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v1~1thresholds~1alerts~1send/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/thresholds/alerts/send","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-SendAlertRequest","exampleIds":["paths/~1v1~1thresholds~1alerts~1send/post/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["200","default"],"pointer":"/v1/thresholds/alerts/send","href":"send-alerts/post-v1-thresholds-alerts-send","openApiOperationId":"POST-v1-thresholds-alerts-send","summary":"Create a send alert for an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-thresholds-api-SendAlertRequest","exampleIds":["paths/~1v1~1thresholds~1alerts~1send/post/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-SendAlertRequest","exampleIds":["paths/~1v1~1thresholds~1alerts~1send/post/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-SendAlertItem","exampleIds":["paths/~1v1~1thresholds~1alerts~1send/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-thresholds-api-SendAlertItem","exampleIds":["paths/~1v1~1thresholds~1alerts~1send/post/responses/200/content/application~1json/examples/Example"]},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1thresholds~1alerts~1send/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-thresholds-api-SendAlertItem","exampleIds":["paths/~1v1~1thresholds~1alerts~1send/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-SendAlertItem","exampleIds":["paths/~1v1~1thresholds~1alerts~1send/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/send-alerts/post-v1-thresholds-alerts-send"}],"panels":[]}]},"httpPath":"/v1/thresholds/alerts/send"},{"label":"Get a send alert","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/send-alerts/get-v1-thresholds-alerts-send--name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/send-alerts/get-v1-thresholds-alerts-send--name-","metadata":{"seo":{"title":"Get a send alert","description":"Get a send alert"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-thresholds-alerts-send--name-","name":"Get a send alert","isWebhook":false,"pointer":"/paths/~1v1~1thresholds~1alerts~1send~1{name}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a send alert","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"Threshold name that identifies this threshold","required":true}],"pointer":"/paths/~1v1~1thresholds~1alerts~1send~1{name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/thresholds/alerts/send/{name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","404","default"],"pointer":"/v1/thresholds/alerts/send/{name}","href":"send-alerts/get-v1-thresholds-alerts-send--name-","openApiOperationId":"GET-v1-thresholds-alerts-send--name-","summary":"Get a send alert"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-SendAlertItem","exampleIds":["paths/~1v1~1thresholds~1alerts~1send~1{name}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-thresholds-api-SendAlertItem","exampleIds":["paths/~1v1~1thresholds~1alerts~1send~1{name}/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1thresholds~1alerts~1send~1{name}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-thresholds-api-SendAlertItem","exampleIds":["paths/~1v1~1thresholds~1alerts~1send~1{name}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-SendAlertItem","exampleIds":["paths/~1v1~1thresholds~1alerts~1send~1{name}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/send-alerts/get-v1-thresholds-alerts-send--name-"}],"panels":[]}]},"httpPath":"/v1/thresholds/alerts/send/{name}"},{"label":"Update a send alert","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/send-alerts/put-v1-thresholds-alerts-send--name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/send-alerts/put-v1-thresholds-alerts-send--name-","metadata":{"seo":{"title":"Update a send alert","description":"Updates the configuration of an existing send alert."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v1-thresholds-alerts-send--name-","name":"Update a send alert","isWebhook":false,"pointer":"/paths/~1v1~1thresholds~1alerts~1send~1{name}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a send alert","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the configuration of an existing send alert."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: This endpoint performs a full replacement (PUT) of the alert resource. To update specific fields like 'alert_channels' without losing existing configuration, you should first fetch the current alert object via a GET request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the attributes from the existing alert to populate the request body, modifying only the 'alert_channels' array (or other desired fields) before sending the PUT request. Omitting existing attributes may result in validation errors or the loss of current settings."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"Threshold name that identifies this threshold","required":true}],"pointer":"/paths/~1v1~1thresholds~1alerts~1send~1{name}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-SendAlertRequest","exampleIds":["paths/~1v1~1thresholds~1alerts~1send~1{name}/put/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-thresholds-api-SendAlertRequest","exampleIds":["paths/~1v1~1thresholds~1alerts~1send~1{name}/put/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v1~1thresholds~1alerts~1send~1{name}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/thresholds/alerts/send/{name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-SendAlertRequest","exampleIds":["paths/~1v1~1thresholds~1alerts~1send~1{name}/put/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["200","400","404","default"],"pointer":"/v1/thresholds/alerts/send/{name}","href":"send-alerts/put-v1-thresholds-alerts-send--name-","openApiOperationId":"PUT-v1-thresholds-alerts-send--name-","summary":"Update a send alert"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-thresholds-api-SendAlertRequest","exampleIds":["paths/~1v1~1thresholds~1alerts~1send~1{name}/put/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-SendAlertRequest","exampleIds":["paths/~1v1~1thresholds~1alerts~1send~1{name}/put/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1thresholds~1alerts~1send~1{name}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/send-alerts/put-v1-thresholds-alerts-send--name-"}],"panels":[]}]},"httpPath":"/v1/thresholds/alerts/send/{name}"},{"label":"Delete a send alert","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/send-alerts/delete-v1-thresholds-alerts-send--name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/send-alerts/delete-v1-thresholds-alerts-send--name-","metadata":{"seo":{"title":"Delete a send alert","description":"Delete a send alert"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v1-thresholds-alerts-send--name-","name":"Delete a send alert","isWebhook":false,"pointer":"/paths/~1v1~1thresholds~1alerts~1send~1{name}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a send alert","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"Threshold name that identifies this threshold","required":true}],"pointer":"/paths/~1v1~1thresholds~1alerts~1send~1{name}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/thresholds/alerts/send/{name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","404","default"],"pointer":"/v1/thresholds/alerts/send/{name}","href":"send-alerts/delete-v1-thresholds-alerts-send--name-","openApiOperationId":"DELETE-v1-thresholds-alerts-send--name-","summary":"Delete a send alert"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1thresholds~1alerts~1send~1{name}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/send-alerts/delete-v1-thresholds-alerts-send--name-"}],"panels":[]}]},"httpPath":"/v1/thresholds/alerts/send/{name}"},{"label":"List account hits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/send-alerts/get-v1-thresholds-hits","routeSlug":"/docs/mailgun/api-reference/send/mailgun/send-alerts/get-v1-thresholds-hits","metadata":{"seo":{"title":"List account hits","description":"List account hits"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-thresholds-hits","name":"List account hits","isWebhook":false,"pointer":"/paths/~1v1~1thresholds~1hits/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List account hits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/thresholds/hits","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/v1/thresholds/hits","href":"send-alerts/get-v1-thresholds-hits","openApiOperationId":"GET-v1-thresholds-hits","summary":"List account hits"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-HitListResponse","exampleIds":["paths/~1v1~1thresholds~1hits/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-thresholds-api-HitListResponse","exampleIds":["paths/~1v1~1thresholds~1hits/get/responses/200/content/application~1json/examples/Example"]},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1thresholds~1hits/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-thresholds-api-HitListResponse","exampleIds":["paths/~1v1~1thresholds~1hits/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-HitListResponse","exampleIds":["paths/~1v1~1thresholds~1hits/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/send-alerts/get-v1-thresholds-hits"}],"panels":[]}]},"httpPath":"/v1/thresholds/hits"}],"content":{"contentType":"group","meta":{"name":"Send Alerts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send Alerts","showPageActions":true},{"nodeType":"markdoc","content":"Mailgun allows you to get instant notifications on the sending metrics that matter most, configured specifically for your unique business needs and assets. Route these alerts to the channels your team relies on. Stay on top of sending performance without the need to manually monitor."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/thresholds/alerts/send","summary":"List send alerts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/send-alerts/get-v1-thresholds-alerts-send","deprecated":false},{"title":"/v1/thresholds/alerts/send","summary":"Create a send alert for an account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/send-alerts/post-v1-thresholds-alerts-send","deprecated":false},{"title":"/v1/thresholds/alerts/send/{name}","summary":"Get a send alert","prefix":{"name":"get","color":"get"},"badges":[],"link":"/send-alerts/get-v1-thresholds-alerts-send--name-","deprecated":false},{"title":"/v1/thresholds/alerts/send/{name}","summary":"Update a send alert","prefix":{"name":"put","color":"put"},"badges":[],"link":"/send-alerts/put-v1-thresholds-alerts-send--name-","deprecated":false},{"title":"/v1/thresholds/alerts/send/{name}","summary":"Delete a send alert","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/send-alerts/delete-v1-thresholds-alerts-send--name-","deprecated":false},{"title":"/v1/thresholds/hits","summary":"List account hits","prefix":{"name":"get","color":"get"},"badges":[],"link":"/send-alerts/get-v1-thresholds-hits","deprecated":false}]}]}]}]}},{"type":"group","label":"Alerts","link":"/docs/mailgun/api-reference/send/mailgun/alerts","routeSlug":"/docs/mailgun/api-reference/send/mailgun/alerts","items":[{"label":"List events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/alerts/get-v1-alerts-events","routeSlug":"/docs/mailgun/api-reference/send/mailgun/alerts/get-v1-alerts-events","metadata":{"seo":{"title":"List events","description":"The current list of events that you can chose to receive alerts for."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-alerts-events","name":"List events","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The current list of events that you can chose to receive alerts for."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/alerts/events","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/v1/alerts/events","href":"alerts/get-v1-alerts-events","openApiOperationId":"GET-v1-alerts-events","summary":"List events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-ListAlertsEventsResp","exampleIds":["paths/~1v1~1alerts~1events/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-ListAlertsEventsResp","exampleIds":["paths/~1v1~1alerts~1events/get/responses/200/content/application~1json/examples/Example"]},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1alerts~1events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-ListAlertsEventsResp","exampleIds":["paths/~1v1~1alerts~1events/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-ListAlertsEventsResp","exampleIds":["paths/~1v1~1alerts~1events/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/get-v1-alerts-events"}],"panels":[]}]},"httpPath":"/v1/alerts/events"},{"label":"Add Alert","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/alerts/post-v1-alerts-settings-events","routeSlug":"/docs/mailgun/api-reference/send/mailgun/alerts/post-v1-alerts-settings-events","metadata":{"seo":{"title":"Add Alert","description":"Use this endpoint to add new alert settings record. This service facilitates notifications (Webhook, Slack, or Email) for both Mailgun Optimize and Send Alert threshold breaches."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v1-alerts-settings-events","name":"Add Alert","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1settings~1events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Alert","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to add new alert settings record. This service facilitates notifications (Webhook, Slack, or Email) for both Mailgun Optimize and Send Alert threshold breaches."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"alerts/post-v1-alerts-settings-events/request/webhooks","deepLinkHash":"/alerts/post-v1-alerts-settings-events#alerts/post-v1-alerts-settings-events/request/webhooks"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This section covers details around consuming alerts via webhooks. If you are familiar with Mailgun Send webhooks (which provide status updates on individual email deliveries),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"there is a lot of overlapping similarity, however, there are also a few minor nuances to account for."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"alerts/post-v1-alerts-settings-events/request/securing-webhooks","deepLinkHash":"/alerts/post-v1-alerts-settings-events#alerts/post-v1-alerts-settings-events/request/securing-webhooks"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Securing Webhooks"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HMAC is used to verify the integrity as well as the authenticity of received webhooks. To verify the origin of a webhook:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Encode the webhook’s entire POST request body with the HMAC algorithm (using your webhook signing key and SHA256 digest mode)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compare the resulting hexdigest to the signature provided in the POST request’s X-Sign header."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: If you’re consuming Mailgun Send webhooks, please note that your Mailgun Send webhook signing key differs"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from your Alerts webhook signing key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your Alerts webhook signing keys, used for both Optimize and Send Alert products, are available within the Mailgun Alerts UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"alerts/post-v1-alerts-settings-events/request/webhook-url-validation","deepLinkHash":"/alerts/post-v1-alerts-settings-events#alerts/post-v1-alerts-settings-events/request/webhook-url-validation"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook URL Validation"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When adding or updating a webhook URL for alerts, we will ensure the endpoint is reachable by sending a GET request to the provided URL. If a 200 response is not returned from your endpoint, the request will be rejected and your alert setting will not be saved. We intentionally chose to send a GET request instead of a POST when validating URLs so that your webhook endpoint does not have to account for test requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additionally, when a POST request is sent to your webhook URL, if a 2xx is not returned, we will attempt retries via an exponential backoff strategy for up to ~8 hours. If the max retry count is reached, the alert will be disabled and the related alert settings record’s disabled_at field will be populated."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-mutateEventSettingReq","exampleIds":["paths/~1v1~1alerts~1settings~1events/post/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-mutateEventSettingReq","exampleIds":["paths/~1v1~1alerts~1settings~1events/post/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v1~1alerts~1settings~1events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/alerts/settings/events","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-mutateEventSettingReq","exampleIds":["paths/~1v1~1alerts~1settings~1events/post/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["200","400","409","default"],"pointer":"/v1/alerts/settings/events","href":"alerts/post-v1-alerts-settings-events","openApiOperationId":"POST-v1-alerts-settings-events","summary":"Add Alert"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-mutateEventSettingReq","exampleIds":["paths/~1v1~1alerts~1settings~1events/post/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-mutateEventSettingReq","exampleIds":["paths/~1v1~1alerts~1settings~1events/post/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-EventSettings","exampleIds":["paths/~1v1~1alerts~1settings~1events/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-EventSettings","exampleIds":["paths/~1v1~1alerts~1settings~1events/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"409","description":"A 409 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1alerts~1settings~1events/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-EventSettings","exampleIds":["paths/~1v1~1alerts~1settings~1events/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-EventSettings","exampleIds":["paths/~1v1~1alerts~1settings~1events/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"409","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/post-v1-alerts-settings-events"}],"panels":[]}]},"httpPath":"/v1/alerts/settings/events"},{"label":"Update Alert","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/alerts/put-v1-alerts-settings-events--id-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/alerts/put-v1-alerts-settings-events--id-","metadata":{"seo":{"title":"Update Alert","description":"Use this endpoint to update an existing alert setting record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v1-alerts-settings-events--id-","name":"Update Alert","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1settings~1events~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Alert","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to update an existing alert setting record.\n\nNOTE: When updating a webhook alert, we will ensure the endpoint is reachable by sending a GET request to the provided URL. If a 200 response is not returned, a 400 will be returned and the alert setting update will be rejected."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/string","description":"The settings ID.","required":true}],"pointer":"/paths/~1v1~1alerts~1settings~1events~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-mutateEventSettingReq","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/put/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-mutateEventSettingReq","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/put/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v1~1alerts~1settings~1events~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/alerts/settings/events/{id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-mutateEventSettingReq","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/put/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["200","400","404","default"],"pointer":"/v1/alerts/settings/events/{id}","href":"alerts/put-v1-alerts-settings-events--id-","openApiOperationId":"PUT-v1-alerts-settings-events--id-","summary":"Update Alert"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-mutateEventSettingReq","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/put/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-mutateEventSettingReq","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/put/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/put/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1alerts~1settings~1events~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/put-v1-alerts-settings-events--id-"}],"panels":[]}]},"httpPath":"/v1/alerts/settings/events/{id}"},{"label":"Remove Alert","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/alerts/delete-v1-alerts-settings-events--id-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/alerts/delete-v1-alerts-settings-events--id-","metadata":{"seo":{"title":"Remove Alert","description":"Remove Alert"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v1-alerts-settings-events--id-","name":"Remove Alert","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1settings~1events~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove Alert","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/string","description":"The settings ID.","required":true}],"pointer":"/paths/~1v1~1alerts~1settings~1events~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/alerts/settings/events/{id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/v1/alerts/settings/events/{id}","href":"alerts/delete-v1-alerts-settings-events--id-","openApiOperationId":"DELETE-v1-alerts-settings-events--id-","summary":"Remove Alert"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/delete/responses/200/content/application~1json/examples/Example"]},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1alerts~1settings~1events~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/delete-v1-alerts-settings-events--id-"}],"panels":[]}]},"httpPath":"/v1/alerts/settings/events/{id}"},{"label":"List Alerts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/alerts/get-v1-alerts-settings","routeSlug":"/docs/mailgun/api-reference/send/mailgun/alerts/get-v1-alerts-settings","metadata":{"seo":{"title":"List Alerts","description":"This endpoint returns a list of all configured alert settings for your account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-alerts-settings","name":"List Alerts","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Alerts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint returns a list of all configured alert settings for your account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/alerts/settings","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/v1/alerts/settings","href":"alerts/get-v1-alerts-settings","openApiOperationId":"GET-v1-alerts-settings","summary":"List Alerts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-SettingsResponse","exampleIds":["paths/~1v1~1alerts~1settings/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-SettingsResponse","exampleIds":["paths/~1v1~1alerts~1settings/get/responses/200/content/application~1json/examples/Example"]},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1alerts~1settings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-SettingsResponse","exampleIds":["paths/~1v1~1alerts~1settings/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-SettingsResponse","exampleIds":["paths/~1v1~1alerts~1settings/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/get-v1-alerts-settings"}],"panels":[]}]},"httpPath":"/v1/alerts/settings"},{"label":"Update Slack settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/alerts/put-v1-alerts-settings-slack","routeSlug":"/docs/mailgun/api-reference/send/mailgun/alerts/put-v1-alerts-settings-slack","metadata":{"seo":{"title":"Update Slack settings","description":"Update Slack settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v1-alerts-settings-slack","name":"Update Slack settings","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1settings~1slack/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Slack settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-Slack"}},"schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-Slack","pointer":"/paths/~1v1~1alerts~1settings~1slack/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/alerts/settings/slack","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-Slack"}},"responseCodes":["204","default"],"pointer":"/v1/alerts/settings/slack","href":"alerts/put-v1-alerts-settings-slack","openApiOperationId":"PUT-v1-alerts-settings-slack","summary":"Update Slack settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-Slack","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-Slack"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"A 204 response"},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1alerts~1settings~1slack/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/put-v1-alerts-settings-slack"}],"panels":[]}]},"httpPath":"/v1/alerts/settings/slack"},{"label":"Delete Slack settings","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/alerts/delete-v1-alerts-settings-slack","routeSlug":"/docs/mailgun/api-reference/send/mailgun/alerts/delete-v1-alerts-settings-slack","metadata":{"seo":{"title":"Delete Slack settings","description":"Delete Slack settings and Slack event settings for the Mailgun account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v1-alerts-settings-slack","name":"Delete Slack settings","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1settings~1slack/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Slack settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete Slack settings and Slack event settings for the Mailgun account.\n\nTo revoke the Slack access token, use DELETE /v1/alerts/slack/oauth.\n\nTo completely remove the Slack App from Slack Workspace, go into App Configuration in Slack."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/alerts/settings/slack","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","default"],"pointer":"/v1/alerts/settings/slack","href":"alerts/delete-v1-alerts-settings-slack","openApiOperationId":"DELETE-v1-alerts-settings-slack","summary":"Delete Slack settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"A 204 response"},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1alerts~1settings~1slack/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/delete-v1-alerts-settings-slack"}],"panels":[]}]},"httpPath":"/v1/alerts/settings/slack"},{"label":"Reset Webhook Signing Key","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/alerts/put-v1-alerts-settings-webhooks-signing-key","routeSlug":"/docs/mailgun/api-reference/send/mailgun/alerts/put-v1-alerts-settings-webhooks-signing-key","metadata":{"seo":{"title":"Reset Webhook Signing Key","description":"Reset Webhook Signing Key"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v1-alerts-settings-webhooks-signing-key","name":"Reset Webhook Signing Key","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1settings~1webhooks~1signing_key/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reset Webhook Signing Key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/alerts/settings/webhooks/signing_key","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/v1/alerts/settings/webhooks/signing_key","href":"alerts/put-v1-alerts-settings-webhooks-signing-key","openApiOperationId":"PUT-v1-alerts-settings-webhooks-signing-key","summary":"Reset Webhook Signing Key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-Webhooks"}},"schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-Webhooks"},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1alerts~1settings~1webhooks~1signing_key/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-Webhooks","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-Webhooks"}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/put-v1-alerts-settings-webhooks-signing-key"}],"panels":[]}]},"httpPath":"/v1/alerts/settings/webhooks/signing_key"},{"label":"Test webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/alerts/post-v1-alerts-webhooks-test","routeSlug":"/docs/mailgun/api-reference/send/mailgun/alerts/post-v1-alerts-webhooks-test","metadata":{"seo":{"title":"Test webhook","description":"Sends test webhook request to specified url with dummy data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v1-alerts-webhooks-test","name":"Test webhook","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1webhooks~1test/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends test webhook request to specified url with dummy data."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestWebhookRequest","exampleIds":["paths/~1v1~1alerts~1webhooks~1test/post/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestWebhookRequest","exampleIds":["paths/~1v1~1alerts~1webhooks~1test/post/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v1~1alerts~1webhooks~1test/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/alerts/webhooks/test","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestWebhookRequest","exampleIds":["paths/~1v1~1alerts~1webhooks~1test/post/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["200","400","default"],"pointer":"/v1/alerts/webhooks/test","href":"alerts/post-v1-alerts-webhooks-test","openApiOperationId":"POST-v1-alerts-webhooks-test","summary":"Test webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestWebhookRequest","exampleIds":["paths/~1v1~1alerts~1webhooks~1test/post/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestWebhookRequest","exampleIds":["paths/~1v1~1alerts~1webhooks~1test/post/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1alerts~1webhooks~1test/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/post-v1-alerts-webhooks-test"}],"panels":[]}]},"httpPath":"/v1/alerts/webhooks/test"},{"label":"Test message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/alerts/post-v1-alerts-email-test","routeSlug":"/docs/mailgun/api-reference/send/mailgun/alerts/post-v1-alerts-email-test","metadata":{"seo":{"title":"Test message","description":"Sends test message to emails with dummy data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v1-alerts-email-test","name":"Test message","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1email~1test/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends test message to emails with dummy data."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestEmailRequest","exampleIds":["paths/~1v1~1alerts~1email~1test/post/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestEmailRequest","exampleIds":["paths/~1v1~1alerts~1email~1test/post/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v1~1alerts~1email~1test/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/alerts/email/test","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestEmailRequest","exampleIds":["paths/~1v1~1alerts~1email~1test/post/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["200","400"],"pointer":"/v1/alerts/email/test","href":"alerts/post-v1-alerts-email-test","openApiOperationId":"POST-v1-alerts-email-test","summary":"Test message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestEmailRequest","exampleIds":["paths/~1v1~1alerts~1email~1test/post/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestEmailRequest","exampleIds":["paths/~1v1~1alerts~1email~1test/post/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1alerts~1email~1test/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/post-v1-alerts-email-test"}],"panels":[]}]},"httpPath":"/v1/alerts/email/test"},{"label":"Test message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/alerts/post-v1-alerts-slack-test","routeSlug":"/docs/mailgun/api-reference/send/mailgun/alerts/post-v1-alerts-slack-test","metadata":{"seo":{"title":"Test message","description":"Sends test message to slack channels with dummy data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v1-alerts-slack-test","name":"Test message","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1slack~1test/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends test message to slack channels with dummy data."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestSlackRequest","exampleIds":["paths/~1v1~1alerts~1slack~1test/post/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestSlackRequest","exampleIds":["paths/~1v1~1alerts~1slack~1test/post/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v1~1alerts~1slack~1test/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/alerts/slack/test","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestSlackRequest","exampleIds":["paths/~1v1~1alerts~1slack~1test/post/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["200","400"],"pointer":"/v1/alerts/slack/test","href":"alerts/post-v1-alerts-slack-test","openApiOperationId":"POST-v1-alerts-slack-test","summary":"Test message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestSlackRequest","exampleIds":["paths/~1v1~1alerts~1slack~1test/post/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestSlackRequest","exampleIds":["paths/~1v1~1alerts~1slack~1test/post/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1alerts~1slack~1test/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/post-v1-alerts-slack-test"}],"panels":[]}]},"httpPath":"/v1/alerts/slack/test"},{"label":"Revoke Slack access token","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/alerts/delete-v1-alerts-slack-oauth","routeSlug":"/docs/mailgun/api-reference/send/mailgun/alerts/delete-v1-alerts-slack-oauth","metadata":{"seo":{"title":"Revoke Slack access token","description":"Revoke Slack access token, delete Slack settings and Slack event settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v1-alerts-slack-oauth","name":"Revoke Slack access token","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1slack~1oauth/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revoke Slack access token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Revoke Slack access token, delete Slack settings and Slack event settings.\n\nNOTE: All Mailgun accounts connected to the same Slack workspace share the same token.\n\nTo completely remove the Slack App from Slack Workspace, go into App Configuration in Slack."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/alerts/slack/oauth","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","default"],"pointer":"/v1/alerts/slack/oauth","href":"alerts/delete-v1-alerts-slack-oauth","openApiOperationId":"DELETE-v1-alerts-slack-oauth","summary":"Revoke Slack access token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"A 204 response"},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1alerts~1slack~1oauth/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/delete-v1-alerts-slack-oauth"}],"panels":[]}]},"httpPath":"/v1/alerts/slack/oauth"},{"label":"Get Slack channel","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/alerts/get-v1-alerts-slack-channels--id-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/alerts/get-v1-alerts-slack-channels--id-","metadata":{"seo":{"title":"Get Slack channel","description":"Returns Slack channel."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-alerts-slack-channels--id-","name":"Get Slack channel","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1slack~1channels~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Slack channel","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns Slack channel."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/string","description":"The Slack channel ID.","required":true}],"pointer":"/paths/~1v1~1alerts~1slack~1channels~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/alerts/slack/channels/{id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v1/alerts/slack/channels/{id}","href":"alerts/get-v1-alerts-slack-channels--id-","openApiOperationId":"GET-v1-alerts-slack-channels--id-","summary":"Get Slack channel"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-SlackChannel","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-SlackChannel","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/401/content/application~1json/examples/Example"]},{"code":"403","description":"A 403 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/403/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/403/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-SlackChannel","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-SlackChannel","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/401/content/application~1json/examples/Example"]}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/403/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/403/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/get-v1-alerts-slack-channels--id-"}],"panels":[]}]},"httpPath":"/v1/alerts/slack/channels/{id}"},{"label":"List Slack channels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/alerts/get-v1-alerts-slack-channels","routeSlug":"/docs/mailgun/api-reference/send/mailgun/alerts/get-v1-alerts-slack-channels","metadata":{"seo":{"title":"List Slack channels","description":"List Slack channels for the connected Slack workspace."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-alerts-slack-channels","name":"List Slack channels","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1slack~1channels/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Slack channels","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List Slack channels for the connected Slack workspace."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"components/schemas/string","description":"Encoded paging information, provided via 'next', 'first' links"},{"name":"limit","in":"query","schemaId":"schema_260","description":"Limits the number of items returned in a request"}],"pointer":"/paths/~1v1~1alerts~1slack~1channels/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/alerts/slack/channels","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"components/schemas/string"},{"name":"limit","in":"query","schemaId":"schema_260"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v1/alerts/slack/channels","href":"alerts/get-v1-alerts-slack-channels","openApiOperationId":"GET-v1-alerts-slack-channels","summary":"List Slack channels"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-ListSlackChannelsResp","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-ListSlackChannelsResp","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/401/content/application~1json/examples/Example"]},{"code":"403","description":"A 403 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/403/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/403/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1alerts~1slack~1channels/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-ListSlackChannelsResp","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-ListSlackChannelsResp","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/401/content/application~1json/examples/Example"]}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/403/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/403/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/get-v1-alerts-slack-channels"}],"panels":[]}]},"httpPath":"/v1/alerts/slack/channels"}],"content":{"contentType":"group","meta":{"name":"Alerts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Alerts","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/alerts/events","summary":"List events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alerts/get-v1-alerts-events","deprecated":false},{"title":"/v1/alerts/settings/events","summary":"Add Alert","prefix":{"name":"post","color":"post"},"badges":[],"link":"/alerts/post-v1-alerts-settings-events","deprecated":false},{"title":"/v1/alerts/settings/events/{id}","summary":"Update Alert","prefix":{"name":"put","color":"put"},"badges":[],"link":"/alerts/put-v1-alerts-settings-events--id-","deprecated":false},{"title":"/v1/alerts/settings/events/{id}","summary":"Remove Alert","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/alerts/delete-v1-alerts-settings-events--id-","deprecated":false},{"title":"/v1/alerts/settings","summary":"List Alerts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alerts/get-v1-alerts-settings","deprecated":false},{"title":"/v1/alerts/settings/slack","summary":"Update Slack settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/alerts/put-v1-alerts-settings-slack","deprecated":false},{"title":"/v1/alerts/settings/slack","summary":"Delete Slack settings","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/alerts/delete-v1-alerts-settings-slack","deprecated":false},{"title":"/v1/alerts/settings/webhooks/signing_key","summary":"Reset Webhook Signing Key","prefix":{"name":"put","color":"put"},"badges":[],"link":"/alerts/put-v1-alerts-settings-webhooks-signing-key","deprecated":false},{"title":"/v1/alerts/webhooks/test","summary":"Test webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/alerts/post-v1-alerts-webhooks-test","deprecated":false},{"title":"/v1/alerts/email/test","summary":"Test message","prefix":{"name":"post","color":"post"},"badges":[],"link":"/alerts/post-v1-alerts-email-test","deprecated":false},{"title":"/v1/alerts/slack/test","summary":"Test message","prefix":{"name":"post","color":"post"},"badges":[],"link":"/alerts/post-v1-alerts-slack-test","deprecated":false},{"title":"/v1/alerts/slack/oauth","summary":"Revoke Slack access token","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/alerts/delete-v1-alerts-slack-oauth","deprecated":false},{"title":"/v1/alerts/slack/channels/{id}","summary":"Get Slack channel","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alerts/get-v1-alerts-slack-channels--id-","deprecated":false},{"title":"/v1/alerts/slack/channels","summary":"List Slack channels","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alerts/get-v1-alerts-slack-channels","deprecated":false}]}]}]}]}},{"type":"separator","label":"Threshold Limits","content":null},{"type":"group","label":"Limits","link":"/docs/mailgun/api-reference/send/mailgun/limits","routeSlug":"/docs/mailgun/api-reference/send/mailgun/limits","items":[{"label":"List limit thresholds for an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/limits/get-v1-thresholds-limits","routeSlug":"/docs/mailgun/api-reference/send/mailgun/limits/get-v1-thresholds-limits","metadata":{"seo":{"title":"List limit thresholds for an account","description":"List limit thresholds for an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-thresholds-limits","name":"List limit thresholds for an account","isWebhook":false,"pointer":"/paths/~1v1~1thresholds~1limits/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List limit thresholds for an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/thresholds/limits","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/v1/thresholds/limits","href":"limits/get-v1-thresholds-limits","openApiOperationId":"GET-v1-thresholds-limits","summary":"List limit thresholds for an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-ThresholdLimitListResponse","exampleIds":["paths/~1v1~1thresholds~1limits/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-thresholds-api-ThresholdLimitListResponse","exampleIds":["paths/~1v1~1thresholds~1limits/get/responses/200/content/application~1json/examples/Example"]},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1thresholds~1limits/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-thresholds-api-ThresholdLimitListResponse","exampleIds":["paths/~1v1~1thresholds~1limits/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-ThresholdLimitListResponse","exampleIds":["paths/~1v1~1thresholds~1limits/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/limits/get-v1-thresholds-limits"}],"panels":[]}]},"httpPath":"/v1/thresholds/limits"},{"label":"Create a limit threshold for an account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/limits/post-v1-thresholds-limits","routeSlug":"/docs/mailgun/api-reference/send/mailgun/limits/post-v1-thresholds-limits","metadata":{"seo":{"title":"Create a limit threshold for an account","description":"Create a limit threshold for an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v1-thresholds-limits","name":"Create a limit threshold for an account","isWebhook":false,"pointer":"/paths/~1v1~1thresholds~1limits/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a limit threshold for an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-LimitRequest","exampleIds":["paths/~1v1~1thresholds~1limits/post/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-thresholds-api-LimitRequest","exampleIds":["paths/~1v1~1thresholds~1limits/post/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v1~1thresholds~1limits/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/thresholds/limits","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-LimitRequest","exampleIds":["paths/~1v1~1thresholds~1limits/post/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["200","default"],"pointer":"/v1/thresholds/limits","href":"limits/post-v1-thresholds-limits","openApiOperationId":"POST-v1-thresholds-limits","summary":"Create a limit threshold for an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-thresholds-api-LimitRequest","exampleIds":["paths/~1v1~1thresholds~1limits/post/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-LimitRequest","exampleIds":["paths/~1v1~1thresholds~1limits/post/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-ThresholdLimitItem","exampleIds":["paths/~1v1~1thresholds~1limits/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-thresholds-api-ThresholdLimitItem","exampleIds":["paths/~1v1~1thresholds~1limits/post/responses/200/content/application~1json/examples/Example"]},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1thresholds~1limits/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-thresholds-api-ThresholdLimitItem","exampleIds":["paths/~1v1~1thresholds~1limits/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-ThresholdLimitItem","exampleIds":["paths/~1v1~1thresholds~1limits/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/limits/post-v1-thresholds-limits"}],"panels":[]}]},"httpPath":"/v1/thresholds/limits"},{"label":"Get a limit threshold for an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/limits/get-v1-thresholds-limits--name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/limits/get-v1-thresholds-limits--name-","metadata":{"seo":{"title":"Get a limit threshold for an account","description":"Get a limit threshold for an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-thresholds-limits--name-","name":"Get a limit threshold for an account","isWebhook":false,"pointer":"/paths/~1v1~1thresholds~1limits~1{name}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a limit threshold for an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"Threshold name that identifies this threshold","required":true}],"pointer":"/paths/~1v1~1thresholds~1limits~1{name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/thresholds/limits/{name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","404","default"],"pointer":"/v1/thresholds/limits/{name}","href":"limits/get-v1-thresholds-limits--name-","openApiOperationId":"GET-v1-thresholds-limits--name-","summary":"Get a limit threshold for an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-ThresholdLimitItem","exampleIds":["paths/~1v1~1thresholds~1limits~1{name}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-thresholds-api-ThresholdLimitItem","exampleIds":["paths/~1v1~1thresholds~1limits~1{name}/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1thresholds~1limits~1{name}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-thresholds-api-ThresholdLimitItem","exampleIds":["paths/~1v1~1thresholds~1limits~1{name}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-ThresholdLimitItem","exampleIds":["paths/~1v1~1thresholds~1limits~1{name}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/limits/get-v1-thresholds-limits--name-"}],"panels":[]}]},"httpPath":"/v1/thresholds/limits/{name}"},{"label":"Update a limit threshold for an account","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/limits/put-v1-thresholds-limits--name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/limits/put-v1-thresholds-limits--name-","metadata":{"seo":{"title":"Update a limit threshold for an account","description":"Update a limit threshold for an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v1-thresholds-limits--name-","name":"Update a limit threshold for an account","isWebhook":false,"pointer":"/paths/~1v1~1thresholds~1limits~1{name}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a limit threshold for an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"Threshold name that identifies this threshold","required":true}],"pointer":"/paths/~1v1~1thresholds~1limits~1{name}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-LimitRequest","exampleIds":["paths/~1v1~1thresholds~1limits~1{name}/put/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-thresholds-api-LimitRequest","exampleIds":["paths/~1v1~1thresholds~1limits~1{name}/put/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v1~1thresholds~1limits~1{name}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/thresholds/limits/{name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-LimitRequest","exampleIds":["paths/~1v1~1thresholds~1limits~1{name}/put/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["200","400","404","default"],"pointer":"/v1/thresholds/limits/{name}","href":"limits/put-v1-thresholds-limits--name-","openApiOperationId":"PUT-v1-thresholds-limits--name-","summary":"Update a limit threshold for an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-thresholds-api-LimitRequest","exampleIds":["paths/~1v1~1thresholds~1limits~1{name}/put/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-thresholds-api-LimitRequest","exampleIds":["paths/~1v1~1thresholds~1limits~1{name}/put/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1thresholds~1limits~1{name}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/limits/put-v1-thresholds-limits--name-"}],"panels":[]}]},"httpPath":"/v1/thresholds/limits/{name}"},{"label":"Delete a limit threshold for an account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/limits/delete-v1-thresholds-limits--name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/limits/delete-v1-thresholds-limits--name-","metadata":{"seo":{"title":"Delete a limit threshold for an account","description":"Delete a limit threshold for an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v1-thresholds-limits--name-","name":"Delete a limit threshold for an account","isWebhook":false,"pointer":"/paths/~1v1~1thresholds~1limits~1{name}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a limit threshold for an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"Threshold name that identifies this threshold","required":true}],"pointer":"/paths/~1v1~1thresholds~1limits~1{name}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/thresholds/limits/{name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","404","default"],"pointer":"/v1/thresholds/limits/{name}","href":"limits/delete-v1-thresholds-limits--name-","openApiOperationId":"DELETE-v1-thresholds-limits--name-","summary":"Delete a limit threshold for an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1thresholds~1limits~1{name}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/limits/delete-v1-thresholds-limits--name-"}],"panels":[]}]},"httpPath":"/v1/thresholds/limits/{name}"}],"content":{"contentType":"group","meta":{"name":"Limits"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Limits","showPageActions":true},{"nodeType":"markdoc","content":"Mailgun allows you to set limits on your subaccounts to help you manage usage and costs. You can create, update, retrieve, and delete limits for various pre-send features such as email previews and email validations."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/thresholds/limits","summary":"List limit thresholds for an account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/limits/get-v1-thresholds-limits","deprecated":false},{"title":"/v1/thresholds/limits","summary":"Create a limit threshold for an account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/limits/post-v1-thresholds-limits","deprecated":false},{"title":"/v1/thresholds/limits/{name}","summary":"Get a limit threshold for an account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/limits/get-v1-thresholds-limits--name-","deprecated":false},{"title":"/v1/thresholds/limits/{name}","summary":"Update a limit threshold for an account","prefix":{"name":"put","color":"put"},"badges":[],"link":"/limits/put-v1-thresholds-limits--name-","deprecated":false},{"title":"/v1/thresholds/limits/{name}","summary":"Delete a limit threshold for an account","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/limits/delete-v1-thresholds-limits--name-","deprecated":false}]}]}]}]}},{"type":"separator","label":"Suppressions","content":null},{"type":"group","label":"Unsubscribe","link":"/docs/mailgun/api-reference/send/mailgun/unsubscribe","routeSlug":"/docs/mailgun/api-reference/send/mailgun/unsubscribe","items":[{"label":"Import unsubscribe list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/unsubscribe/post-v3--domainid--unsubscribes-import","routeSlug":"/docs/mailgun/api-reference/send/mailgun/unsubscribe/post-v3--domainid--unsubscribes-import","metadata":{"seo":{"title":"Import unsubscribe list","description":"Import a CSV file containing a list of addresses to add to the unsubscribe list. The CSV file must be 25MB or under and can contain the following column headers: address, tags, created_at. address is a valid email address (required). tags is tag to unsubscribe from, use * to unsubscribe an address from all domain's correspondence (optional, default: *). created_at is timestamp of unsubscribe event in RFC2822 format (optional, default: current time)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3--domainID--unsubscribes-import","name":"Import unsubscribe list","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1unsubscribes~1import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import unsubscribe list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import a CSV file containing a list of addresses to add to the unsubscribe list. The CSV file must be 25MB or under and can contain the following column headers: address, tags, created_at. address is a valid email address (required). tags is tag to unsubscribe from, use * to unsubscribe an address from all domain's correspondence (optional, default: *). created_at is timestamp of unsubscribe event in RFC2822 format (optional, default: current time)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain to update unsubscribes for","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1unsubscribes~1import/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content-Type must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipart/form-data"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v3~1{domain_name}~1unsubscribes~1import/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domainID-unsubscribes-import-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/POST-v3-domainID-unsubscribes-import-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1{domain_name}~1unsubscribes~1import/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/{domain_name}/unsubscribes/import","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"components/schemas/string"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domainID-unsubscribes-import-multipart-form-data-RequestBody"}},"responseCodes":["202","400","500"],"pointer":"/v3/{domain_name}/unsubscribes/import","href":"unsubscribe/post-v3--domainid--unsubscribes-import","openApiOperationId":"POST-v3--domainID--unsubscribes-import","summary":"Import unsubscribe list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/POST-v3-domainID-unsubscribes-import-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domainID-unsubscribes-import-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"A 202 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1import/post/responses/202/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1import/post/responses/202/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1import/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1import/post/responses/400/content/application~1json/examples/Example"]},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1import/post/responses/500/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1import/post/responses/500/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain_name}~1unsubscribes~1import/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1import/post/responses/202/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1import/post/responses/202/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1import/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1import/post/responses/400/content/application~1json/examples/Example"]}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1import/post/responses/500/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1import/post/responses/500/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/unsubscribe/post-v3--domainid--unsubscribes-import"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/unsubscribes/import"},{"label":"Lookup unsubscribe record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/unsubscribe/get-v3--domainid--unsubscribes--address-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/unsubscribe/get-v3--domainid--unsubscribes--address-","metadata":{"seo":{"title":"Lookup unsubscribe record","description":"Fetch a single unsubscribe record to check if a given address is present in a list of unsubscribed users."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3--domainID--unsubscribes--address-","name":"Lookup unsubscribe record","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1unsubscribes~1{address}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lookup unsubscribe record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch a single unsubscribe record to check if a given address is present in a list of unsubscribed users."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain to retrieve the unsubscribe from","required":true},{"name":"address","in":"path","schemaId":"components/schemas/string","description":"The address to search for","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1unsubscribes~1{address}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/{domain_name}/unsubscribes/{address}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"address","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/{domain_name}/unsubscribes/{address}","href":"unsubscribe/get-v3--domainid--unsubscribes--address-","openApiOperationId":"GET-v3--domainID--unsubscribes--address-","summary":"Lookup unsubscribe record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-model-Unsubscribe","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1{address}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-blackbook-model-Unsubscribe","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1{address}/get/responses/200/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1{address}/get/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1{address}/get/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain_name}~1unsubscribes~1{address}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-blackbook-model-Unsubscribe","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1{address}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-model-Unsubscribe","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1{address}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1{address}/get/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1{address}/get/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/unsubscribe/get-v3--domainid--unsubscribes--address-"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/unsubscribes/{address}"},{"label":"Remove unsubscribe","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/unsubscribe/delete-v3--domainid--unsubscribes--address-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/unsubscribe/delete-v3--domainid--unsubscribes--address-","metadata":{"seo":{"title":"Remove unsubscribe","description":"Delivery to the deleted email address resumes until it unsubscribes again."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3--domainID--unsubscribes--address-","name":"Remove unsubscribe","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1unsubscribes~1{address}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove unsubscribe","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delivery to the deleted email address resumes until it unsubscribes again."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain to delete the unsubscribe from","required":true},{"name":"address","in":"path","schemaId":"components/schemas/string","description":"The address to remove","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1unsubscribes~1{address}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/{domain_name}/unsubscribes/{address}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"address","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/v3/{domain_name}/unsubscribes/{address}","href":"unsubscribe/delete-v3--domainid--unsubscribes--address-","openApiOperationId":"DELETE-v3--domainID--unsubscribes--address-","summary":"Remove unsubscribe"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-suppressionResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1{address}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-blackbook-api-suppressionResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1{address}/delete/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1{address}/delete/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1{address}/delete/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain_name}~1unsubscribes~1{address}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-blackbook-api-suppressionResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1{address}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-suppressionResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1{address}/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1{address}/delete/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes~1{address}/delete/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/unsubscribe/delete-v3--domainid--unsubscribes--address-"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/unsubscribes/{address}"},{"label":"List all unsubscribes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/unsubscribe/get-v3--domainid--unsubscribes","routeSlug":"/docs/mailgun/api-reference/send/mailgun/unsubscribe/get-v3--domainid--unsubscribes","metadata":{"seo":{"title":"List all unsubscribes","description":"Paginate over a list of unsubscribes for domain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3--domainID--unsubscribes","name":"List all unsubscribes","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1unsubscribes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all unsubscribes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Paginate over a list of unsubscribes for domain."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain to retrieve unsubscribes from","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1unsubscribes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_260","description":"Maximum number of records to return (optional, default: 100, max: 1000)"},{"name":"page","in":"query","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page direction relative to the above address, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if empty, returns the first page"},"children":[]}]}]}]},{"name":"address","in":"query","schemaId":"components/schemas/string","description":"address serving as a \"divider\" between pages","required":true},{"name":"term","in":"query","schemaId":"components/schemas/string","description":"Filter records based on addresses that start with the specified substring.","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1unsubscribes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/{domain_name}/unsubscribes","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"limit","in":"query","schemaId":"schema_260"},{"name":"page","in":"query","schemaId":"components/schemas/string"},{"name":"address","in":"query","required":true,"schemaId":"components/schemas/string"},{"name":"term","in":"query","required":true,"schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/{domain_name}/unsubscribes","href":"unsubscribe/get-v3--domainid--unsubscribes","openApiOperationId":"GET-v3--domainID--unsubscribes","summary":"List all unsubscribes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-getUnsubscribesPaginationResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-blackbook-api-getUnsubscribesPaginationResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1{domain_name}~1unsubscribes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-blackbook-api-getUnsubscribesPaginationResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-getUnsubscribesPaginationResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/unsubscribe/get-v3--domainid--unsubscribes"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/unsubscribes"},{"label":"Add unsubscribes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/unsubscribe/post-v3--domainid--unsubscribes","routeSlug":"/docs/mailgun/api-reference/send/mailgun/unsubscribe/post-v3--domainid--unsubscribes","metadata":{"seo":{"title":"Add unsubscribes","description":"Request body is expected to be a valid JSON encoded sting containing up to 1000 unsubscribe records or a single unsubscribe record as application/form-data"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3--domainID--unsubscribes","name":"Add unsubscribes","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1unsubscribes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add unsubscribes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Request body is expected to be a valid JSON encoded sting containing up to 1000 unsubscribe records or a single unsubscribe record as application/form-data"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain to add the unsubscribe to","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1unsubscribes/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content-Type must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if inserting using JSON, no header necessary for form-data insertion"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v3~1{domain_name}~1unsubscribes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-UnsubscribesList","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes/post/requestBody/content/application~1json/examples/Example"]},"application/form-data":{"schemaId":"components/schemas/POST-v3-domainID-unsubscribes-application-form-data-RequestBody"}},"schemaId":"components/schemas/github.com-mailgun-blackbook-api-UnsubscribesList","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes/post/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v3~1{domain_name}~1unsubscribes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/{domain_name}/unsubscribes","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"components/schemas/string"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-UnsubscribesList","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes/post/requestBody/content/application~1json/examples/Example"]},"application/form-data":{"schemaId":"components/schemas/POST-v3-domainID-unsubscribes-application-form-data-RequestBody"}},"responseCodes":["200","400"],"pointer":"/v3/{domain_name}/unsubscribes","href":"unsubscribe/post-v3--domainid--unsubscribes","openApiOperationId":"POST-v3--domainID--unsubscribes","summary":"Add unsubscribes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-blackbook-api-UnsubscribesList","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes/post/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json","application/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-UnsubscribesList","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes/post/requestBody/content/application~1json/examples/Example"]},"application/form-data":{"schemaId":"components/schemas/POST-v3-domainID-unsubscribes-application-form-data-RequestBody"}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes/post/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain_name}~1unsubscribes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes/post/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/unsubscribe/post-v3--domainid--unsubscribes"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/unsubscribes"},{"label":"Clear all unsubscribes","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/unsubscribe/delete-v3--domainid--unsubscribes","routeSlug":"/docs/mailgun/api-reference/send/mailgun/unsubscribe/delete-v3--domainid--unsubscribes","metadata":{"seo":{"title":"Clear all unsubscribes","description":"Clear all unsubscribe email addresses for the domain. Delivery to the deleted email addresses will no longer be suppressed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3--domainID--unsubscribes","name":"Clear all unsubscribes","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1unsubscribes/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clear all unsubscribes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Clear all unsubscribe email addresses for the domain. Delivery to the deleted email addresses will no longer be suppressed."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain to delete unsubscribes from","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1unsubscribes/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/{domain_name}/unsubscribes","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/v3/{domain_name}/unsubscribes","href":"unsubscribe/delete-v3--domainid--unsubscribes","openApiOperationId":"DELETE-v3--domainID--unsubscribes","summary":"Clear all unsubscribes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes/delete/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1{domain_name}~1unsubscribes/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1unsubscribes/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/unsubscribe/delete-v3--domainid--unsubscribes"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/unsubscribes"}],"content":{"contentType":"group","meta":{"name":"Unsubscribe"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unsubscribe","showPageActions":true},{"nodeType":"markdoc","content":"Unsubscribe list stores email addresses of recipients who unsubscribed from your mailings by clicking a Mailgun generated unsubscribe link."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/{domain_name}/unsubscribes/import","summary":"Import unsubscribe list","prefix":{"name":"post","color":"post"},"badges":[],"link":"/unsubscribe/post-v3--domainid--unsubscribes-import","deprecated":false},{"title":"/v3/{domain_name}/unsubscribes/{address}","summary":"Lookup unsubscribe record","prefix":{"name":"get","color":"get"},"badges":[],"link":"/unsubscribe/get-v3--domainid--unsubscribes--address-","deprecated":false},{"title":"/v3/{domain_name}/unsubscribes/{address}","summary":"Remove unsubscribe","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/unsubscribe/delete-v3--domainid--unsubscribes--address-","deprecated":false},{"title":"/v3/{domain_name}/unsubscribes","summary":"List all unsubscribes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/unsubscribe/get-v3--domainid--unsubscribes","deprecated":false},{"title":"/v3/{domain_name}/unsubscribes","summary":"Add unsubscribes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/unsubscribe/post-v3--domainid--unsubscribes","deprecated":false},{"title":"/v3/{domain_name}/unsubscribes","summary":"Clear all unsubscribes","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/unsubscribe/delete-v3--domainid--unsubscribes","deprecated":false}]}]}]}]}},{"type":"group","label":"Complaints","link":"/docs/mailgun/api-reference/send/mailgun/complaints","routeSlug":"/docs/mailgun/api-reference/send/mailgun/complaints","items":[{"label":"Import complaint list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/complaints/post-v3--domainid--complaints-import","routeSlug":"/docs/mailgun/api-reference/send/mailgun/complaints/post-v3--domainid--complaints-import","metadata":{"seo":{"title":"Import complaint list","description":"Import a CSV file containing a list of addresses to add to the complaint list. The CSV file must be 25MB or under and can contain the following column headers: address, created_at. address is a valid email address (required). created_at is timestamp of complaint event in RFC2822 format (optional, default: current time)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3--domainID--complaints-import","name":"Import complaint list","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1complaints~1import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import complaint list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import a CSV file containing a list of addresses to add to the complaint list. The CSV file must be 25MB or under and can contain the following column headers: address, created_at. address is a valid email address (required). created_at is timestamp of complaint event in RFC2822 format (optional, default: current time)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain to update complaints for","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1complaints~1import/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content-Type must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipart/form-data"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v3~1{domain_name}~1complaints~1import/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domainID-unsubscribes-import-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/POST-v3-domainID-unsubscribes-import-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1{domain_name}~1complaints~1import/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/{domain_name}/complaints/import","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"components/schemas/string"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domainID-unsubscribes-import-multipart-form-data-RequestBody"}},"responseCodes":["202","400","500"],"pointer":"/v3/{domain_name}/complaints/import","href":"complaints/post-v3--domainid--complaints-import","openApiOperationId":"POST-v3--domainID--complaints-import","summary":"Import complaint list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/POST-v3-domainID-unsubscribes-import-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domainID-unsubscribes-import-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"A 202 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1import/post/responses/202/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1import/post/responses/202/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1import/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1import/post/responses/400/content/application~1json/examples/Example"]},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1import/post/responses/500/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1import/post/responses/500/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain_name}~1complaints~1import/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1import/post/responses/202/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1import/post/responses/202/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1import/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1import/post/responses/400/content/application~1json/examples/Example"]}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1import/post/responses/500/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1import/post/responses/500/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/complaints/post-v3--domainid--complaints-import"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/complaints/import"},{"label":"Lookup complaint record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/complaints/get-v3--domainid--complaints--address-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/complaints/get-v3--domainid--complaints--address-","metadata":{"seo":{"title":"Lookup complaint record","description":"Fetch a single complaint records to check if a given address is present in the list of complaints."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3--domainID--complaints--address-","name":"Lookup complaint record","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1complaints~1{address}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lookup complaint record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch a single complaint records to check if a given address is present in the list of complaints."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain to retrieve the complaint from","required":true},{"name":"address","in":"path","schemaId":"components/schemas/string","description":"The address to search for","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1complaints~1{address}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/{domain_name}/complaints/{address}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"address","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/{domain_name}/complaints/{address}","href":"complaints/get-v3--domainid--complaints--address-","openApiOperationId":"GET-v3--domainID--complaints--address-","summary":"Lookup complaint record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-model-Complaint","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1{address}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-blackbook-model-Complaint","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1{address}/get/responses/200/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1{address}/get/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1{address}/get/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain_name}~1complaints~1{address}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-blackbook-model-Complaint","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1{address}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-model-Complaint","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1{address}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1{address}/get/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1{address}/get/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/complaints/get-v3--domainid--complaints--address-"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/complaints/{address}"},{"label":"Remove complaint","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/complaints/delete-v3--domainid--complaints--address-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/complaints/delete-v3--domainid--complaints--address-","metadata":{"seo":{"title":"Remove complaint","description":"Delivery to the deleted email address resumes until there is another complaint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3--domainID--complaints--address-","name":"Remove complaint","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1complaints~1{address}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove complaint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delivery to the deleted email address resumes until there is another complaint."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain to delete the complaint from","required":true},{"name":"address","in":"path","schemaId":"components/schemas/string","description":"The address to remove","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1complaints~1{address}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/{domain_name}/complaints/{address}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"address","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/{domain_name}/complaints/{address}","href":"complaints/delete-v3--domainid--complaints--address-","openApiOperationId":"DELETE-v3--domainID--complaints--address-","summary":"Remove complaint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-suppressionResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1{address}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-blackbook-api-suppressionResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1{address}/delete/responses/200/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1{address}/delete/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1{address}/delete/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain_name}~1complaints~1{address}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-blackbook-api-suppressionResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1{address}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-suppressionResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1{address}/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1{address}/delete/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints~1{address}/delete/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/complaints/delete-v3--domainid--complaints--address-"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/complaints/{address}"},{"label":"List all complaints","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/complaints/get-v3--domainid--complaints","routeSlug":"/docs/mailgun/api-reference/send/mailgun/complaints/get-v3--domainid--complaints","metadata":{"seo":{"title":"List all complaints","description":"Paginate a list of complaints for the domain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3--domainID--complaints","name":"List all complaints","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1complaints/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all complaints","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Paginate a list of complaints for the domain."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain to retrieve complaints from","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1complaints/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_260","description":"Maximum number of records to return (optional, default: 100, max: 1000)"},{"name":"page","in":"query","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page direction relative to the above address, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if empty, returns the first page"},"children":[]}]}]}]},{"name":"address","in":"query","schemaId":"components/schemas/string","description":"address serving as a \"divider\" between pages","required":true},{"name":"term","in":"query","schemaId":"components/schemas/string","description":"Filter records based on addresses that start with the specified substring.","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1complaints/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/{domain_name}/complaints","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"limit","in":"query","schemaId":"schema_260"},{"name":"page","in":"query","schemaId":"components/schemas/string"},{"name":"address","in":"query","required":true,"schemaId":"components/schemas/string"},{"name":"term","in":"query","required":true,"schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/{domain_name}/complaints","href":"complaints/get-v3--domainid--complaints","openApiOperationId":"GET-v3--domainID--complaints","summary":"List all complaints"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-getComplaintsPaginationResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-blackbook-api-getComplaintsPaginationResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1{domain_name}~1complaints/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-blackbook-api-getComplaintsPaginationResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-getComplaintsPaginationResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/complaints/get-v3--domainid--complaints"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/complaints"},{"label":"Add complaints","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/complaints/post-v3--domainid--complaints","routeSlug":"/docs/mailgun/api-reference/send/mailgun/complaints/post-v3--domainid--complaints","metadata":{"seo":{"title":"Add complaints","description":"Request body is expected to be a valid JSON encoded sting containing up to 1000 complaint records or a single complaint record as application/form-data"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3--domainID--complaints","name":"Add complaints","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1complaints/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add complaints","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Request body is expected to be a valid JSON encoded sting containing up to 1000 complaint records or a single complaint record as application/form-data"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain to add the complaint to","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1complaints/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content-Type must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if inserting using JSON, no header necessary for form-data insertion"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v3~1{domain_name}~1complaints/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-ComplaintsList","exampleIds":["paths/~1v3~1{domain_name}~1complaints/post/requestBody/content/application~1json/examples/Example"]},"application/form-data":{"schemaId":"components/schemas/POST-v3-domainID-complaints-application-form-data-RequestBody"}},"schemaId":"components/schemas/github.com-mailgun-blackbook-api-ComplaintsList","exampleIds":["paths/~1v3~1{domain_name}~1complaints/post/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v3~1{domain_name}~1complaints/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/{domain_name}/complaints","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"components/schemas/string"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-ComplaintsList","exampleIds":["paths/~1v3~1{domain_name}~1complaints/post/requestBody/content/application~1json/examples/Example"]},"application/form-data":{"schemaId":"components/schemas/POST-v3-domainID-complaints-application-form-data-RequestBody"}},"responseCodes":["200","400"],"pointer":"/v3/{domain_name}/complaints","href":"complaints/post-v3--domainid--complaints","openApiOperationId":"POST-v3--domainID--complaints","summary":"Add complaints"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-blackbook-api-ComplaintsList","exampleIds":["paths/~1v3~1{domain_name}~1complaints/post/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json","application/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-ComplaintsList","exampleIds":["paths/~1v3~1{domain_name}~1complaints/post/requestBody/content/application~1json/examples/Example"]},"application/form-data":{"schemaId":"components/schemas/POST-v3-domainID-complaints-application-form-data-RequestBody"}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints/post/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain_name}~1complaints/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints/post/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/complaints/post-v3--domainid--complaints"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/complaints"},{"label":"Clear all complaints","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/complaints/delete-v3--domainid--complaints","routeSlug":"/docs/mailgun/api-reference/send/mailgun/complaints/delete-v3--domainid--complaints","metadata":{"seo":{"title":"Clear all complaints","description":"Clears all email addresses with complaints from the domain. Delivery to the deleted email addresses will longer be suppressed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3--domainID--complaints","name":"Clear all complaints","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1complaints/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clear all complaints","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Clears all email addresses with complaints from the domain. Delivery to the deleted email addresses will longer be suppressed."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain to delete complaints from","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1complaints/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/{domain_name}/complaints","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/{domain_name}/complaints","href":"complaints/delete-v3--domainid--complaints","openApiOperationId":"DELETE-v3--domainID--complaints","summary":"Clear all complaints"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints/delete/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1{domain_name}~1complaints/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1complaints/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/complaints/delete-v3--domainid--complaints"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/complaints"}],"content":{"contentType":"group","meta":{"name":"Complaints"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Complaints","showPageActions":true},{"nodeType":"markdoc","content":"Email addresses of recipients who marked your messages as a spam (for ESPs that support FBL)."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/{domain_name}/complaints/import","summary":"Import complaint list","prefix":{"name":"post","color":"post"},"badges":[],"link":"/complaints/post-v3--domainid--complaints-import","deprecated":false},{"title":"/v3/{domain_name}/complaints/{address}","summary":"Lookup complaint record","prefix":{"name":"get","color":"get"},"badges":[],"link":"/complaints/get-v3--domainid--complaints--address-","deprecated":false},{"title":"/v3/{domain_name}/complaints/{address}","summary":"Remove complaint","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/complaints/delete-v3--domainid--complaints--address-","deprecated":false},{"title":"/v3/{domain_name}/complaints","summary":"List all complaints","prefix":{"name":"get","color":"get"},"badges":[],"link":"/complaints/get-v3--domainid--complaints","deprecated":false},{"title":"/v3/{domain_name}/complaints","summary":"Add complaints","prefix":{"name":"post","color":"post"},"badges":[],"link":"/complaints/post-v3--domainid--complaints","deprecated":false},{"title":"/v3/{domain_name}/complaints","summary":"Clear all complaints","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/complaints/delete-v3--domainid--complaints","deprecated":false}]}]}]}]}},{"type":"group","label":"Bounces","link":"/docs/mailgun/api-reference/send/mailgun/bounces","routeSlug":"/docs/mailgun/api-reference/send/mailgun/bounces","items":[{"label":"Import list of bounces","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/bounces/post-v3--domainid--bounces-import","routeSlug":"/docs/mailgun/api-reference/send/mailgun/bounces/post-v3--domainid--bounces-import","metadata":{"seo":{"title":"Import list of bounces","description":"Import a CSV file containing a list of addresses to add to the bounce list. The CSV file must be 25MB or under and must contain the following column headers: address, code, error, created_at. address is a valid email address. code is error code (optional, default: 550). error is error description (optional, default: empty string). created_at is timestamp of bounce event in RFC2822 format (optional, default: current time)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3--domainID--bounces-import","name":"Import list of bounces","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1bounces~1import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import list of bounces","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import a CSV file containing a list of addresses to add to the bounce list. The CSV file must be 25MB or under and must contain the following column headers: address, code, error, created_at. address is a valid email address. code is error code (optional, default: 550). error is error description (optional, default: empty string). created_at is timestamp of bounce event in RFC2822 format (optional, default: current time)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain to update bounces for","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1bounces~1import/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content-Type must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipart/form-data"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v3~1{domain_name}~1bounces~1import/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domainID-unsubscribes-import-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/POST-v3-domainID-unsubscribes-import-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1{domain_name}~1bounces~1import/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/{domain_name}/bounces/import","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"components/schemas/string"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domainID-unsubscribes-import-multipart-form-data-RequestBody"}},"responseCodes":["202","400","500"],"pointer":"/v3/{domain_name}/bounces/import","href":"bounces/post-v3--domainid--bounces-import","openApiOperationId":"POST-v3--domainID--bounces-import","summary":"Import list of bounces"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/POST-v3-domainID-unsubscribes-import-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domainID-unsubscribes-import-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"A 202 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1import/post/responses/202/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1import/post/responses/202/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1import/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1import/post/responses/400/content/application~1json/examples/Example"]},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1import/post/responses/500/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1import/post/responses/500/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain_name}~1bounces~1import/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1import/post/responses/202/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1import/post/responses/202/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1import/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1import/post/responses/400/content/application~1json/examples/Example"]}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1import/post/responses/500/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1import/post/responses/500/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bounces/post-v3--domainid--bounces-import"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/bounces/import"},{"label":"Lookup bounce record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/bounces/get-v3--domainid--bounces--address-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/bounces/get-v3--domainid--bounces--address-","metadata":{"seo":{"title":"Lookup bounce record","description":"Fetch a single bounce event by a given email address."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3--domainID--bounces--address-","name":"Lookup bounce record","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1bounces~1{address}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lookup bounce record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch a single bounce event by a given email address."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain to retrieve the bounce from","required":true},{"name":"address","in":"path","schemaId":"components/schemas/string","description":"The address to search for","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1bounces~1{address}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/{domain_name}/bounces/{address}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"address","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/{domain_name}/bounces/{address}","href":"bounces/get-v3--domainid--bounces--address-","openApiOperationId":"GET-v3--domainID--bounces--address-","summary":"Lookup bounce record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-model-Bounce","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1{address}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-blackbook-model-Bounce","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1{address}/get/responses/200/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1{address}/get/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1{address}/get/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain_name}~1bounces~1{address}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-blackbook-model-Bounce","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1{address}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-model-Bounce","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1{address}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1{address}/get/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1{address}/get/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bounces/get-v3--domainid--bounces--address-"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/bounces/{address}"},{"label":"Remove bounce","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/bounces/delete-v3--domainid--bounces--address-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/bounces/delete-v3--domainid--bounces--address-","metadata":{"seo":{"title":"Remove bounce","description":"Delivery to the deleted email address resumes until it bounces again."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3--domainID--bounces--address-","name":"Remove bounce","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1bounces~1{address}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove bounce","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delivery to the deleted email address resumes until it bounces again."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain to delete the bounce from","required":true},{"name":"address","in":"path","schemaId":"components/schemas/string","description":"The address to remove","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1bounces~1{address}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/{domain_name}/bounces/{address}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"address","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/v3/{domain_name}/bounces/{address}","href":"bounces/delete-v3--domainid--bounces--address-","openApiOperationId":"DELETE-v3--domainID--bounces--address-","summary":"Remove bounce"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-suppressionResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1{address}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-blackbook-api-suppressionResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1{address}/delete/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1{address}/delete/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1{address}/delete/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain_name}~1bounces~1{address}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-blackbook-api-suppressionResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1{address}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-suppressionResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1{address}/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1{address}/delete/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces~1{address}/delete/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bounces/delete-v3--domainid--bounces--address-"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/bounces/{address}"},{"label":"List all bounces","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/bounces/get-v3--domainid--bounces","routeSlug":"/docs/mailgun/api-reference/send/mailgun/bounces/get-v3--domainid--bounces","metadata":{"seo":{"title":"List all bounces","description":"Paginate over a list of bounces for a domain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3--domainID--bounces","name":"List all bounces","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1bounces/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all bounces","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Paginate over a list of bounces for a domain."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain to retrieve bounces from","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1bounces/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_260","description":"Maximum number of records to return (optional, default: 100, max: 1000)","required":true},{"name":"page","in":"query","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page direction relative to the above address, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if empty, returns the first page"},"children":[]}]}]}],"required":true},{"name":"term","in":"query","schemaId":"components/schemas/string","description":"Filter records based on addresses that start with the specified substring.","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1bounces/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/{domain_name}/bounces","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"limit","in":"query","required":true,"schemaId":"schema_260"},{"name":"page","in":"query","required":true,"schemaId":"components/schemas/string"},{"name":"term","in":"query","required":true,"schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/{domain_name}/bounces","href":"bounces/get-v3--domainid--bounces","openApiOperationId":"GET-v3--domainID--bounces","summary":"List all bounces"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-getBouncesPaginationResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-blackbook-api-getBouncesPaginationResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1{domain_name}~1bounces/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-blackbook-api-getBouncesPaginationResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-getBouncesPaginationResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bounces/get-v3--domainid--bounces"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/bounces"},{"label":"Add bounces","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/bounces/post-v3--domainid--bounces","routeSlug":"/docs/mailgun/api-reference/send/mailgun/bounces/post-v3--domainid--bounces","metadata":{"seo":{"title":"Add bounces","description":"Request body is expected to be a valid JSON encoded sting containing up to 1000 bounce records or a single bounce record as application/form-data"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3--domainID--bounces","name":"Add bounces","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1bounces/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add bounces","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Request body is expected to be a valid JSON encoded sting containing up to 1000 bounce records or a single bounce record as application/form-data"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain to add the bounce to","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1bounces/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content-Type must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if inserting using JSON, no header necessary for form-data insertion"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v3~1{domain_name}~1bounces/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-BouncesList","exampleIds":["paths/~1v3~1{domain_name}~1bounces/post/requestBody/content/application~1json/examples/Example"]},"application/form-data":{"schemaId":"components/schemas/POST-v3-domainID-bounces-application-form-data-RequestBody"}},"schemaId":"components/schemas/github.com-mailgun-blackbook-api-BouncesList","exampleIds":["paths/~1v3~1{domain_name}~1bounces/post/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v3~1{domain_name}~1bounces/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/{domain_name}/bounces","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"components/schemas/string"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-BouncesList","exampleIds":["paths/~1v3~1{domain_name}~1bounces/post/requestBody/content/application~1json/examples/Example"]},"application/form-data":{"schemaId":"components/schemas/POST-v3-domainID-bounces-application-form-data-RequestBody"}},"responseCodes":["200","400"],"pointer":"/v3/{domain_name}/bounces","href":"bounces/post-v3--domainid--bounces","openApiOperationId":"POST-v3--domainID--bounces","summary":"Add bounces"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-blackbook-api-BouncesList","exampleIds":["paths/~1v3~1{domain_name}~1bounces/post/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json","application/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-BouncesList","exampleIds":["paths/~1v3~1{domain_name}~1bounces/post/requestBody/content/application~1json/examples/Example"]},"application/form-data":{"schemaId":"components/schemas/POST-v3-domainID-bounces-application-form-data-RequestBody"}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces/post/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain_name}~1bounces/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces/post/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bounces/post-v3--domainid--bounces"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/bounces"},{"label":"Clear all bounces","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/bounces/delete-v3--domainid--bounces","routeSlug":"/docs/mailgun/api-reference/send/mailgun/bounces/delete-v3--domainid--bounces","metadata":{"seo":{"title":"Clear all bounces","description":"Clears all email addresses with bounces from the domain. Delivery to the deleted email addresses will longer be suppressed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3--domainID--bounces","name":"Clear all bounces","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1bounces/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clear all bounces","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Clears all email addresses with bounces from the domain. Delivery to the deleted email addresses will longer be suppressed."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain to delete bounces from","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1bounces/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/{domain_name}/bounces","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/v3/{domain_name}/bounces","href":"bounces/delete-v3--domainid--bounces","openApiOperationId":"DELETE-v3--domainID--bounces","summary":"Clear all bounces"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces/delete/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1{domain_name}~1bounces/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1bounces/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bounces/delete-v3--domainid--bounces"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/bounces"}],"content":{"contentType":"group","meta":{"name":"Bounces"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bounces","showPageActions":true},{"nodeType":"markdoc","content":"Bounces - Bounce list stores events of delivery failures due to permanent recipient mailbox errors such as non-existent mailbox. Soft bounces (for example, mailbox is full) and other failures (for example, ESP rejects an email because it thinks it is spam) are not added to the list."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/{domain_name}/bounces/import","summary":"Import list of bounces","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bounces/post-v3--domainid--bounces-import","deprecated":false},{"title":"/v3/{domain_name}/bounces/{address}","summary":"Lookup bounce record","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bounces/get-v3--domainid--bounces--address-","deprecated":false},{"title":"/v3/{domain_name}/bounces/{address}","summary":"Remove bounce","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/bounces/delete-v3--domainid--bounces--address-","deprecated":false},{"title":"/v3/{domain_name}/bounces","summary":"List all bounces","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bounces/get-v3--domainid--bounces","deprecated":false},{"title":"/v3/{domain_name}/bounces","summary":"Add bounces","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bounces/post-v3--domainid--bounces","deprecated":false},{"title":"/v3/{domain_name}/bounces","summary":"Clear all bounces","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/bounces/delete-v3--domainid--bounces","deprecated":false}]}]}]}]}},{"type":"group","label":"Allowlist","link":"/docs/mailgun/api-reference/send/mailgun/allowlist","routeSlug":"/docs/mailgun/api-reference/send/mailgun/allowlist","items":[{"label":"Import allowlist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/allowlist/post-v3--domainid--whitelists-import","routeSlug":"/docs/mailgun/api-reference/send/mailgun/allowlist/post-v3--domainid--whitelists-import","metadata":{"seo":{"title":"Import allowlist","description":"Import a CSV file containing a list of addresses and/or domains to add to the allowlist. The CSV file must be 25MB or under and must contain the following column headers: address, domain. For each row provide either an address or a domain, but not both - choose one, keep the other blank."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3--domainID--whitelists-import","name":"Import allowlist","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1whitelists~1import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import allowlist","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Import a CSV file containing a list of addresses and/or domains to add to the allowlist. The CSV file must be 25MB or under and must contain the following column headers: address, domain. For each row provide either an address or a domain, but not both - choose one, keep the other blank."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain to update allowlist for","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1whitelists~1import/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content-Type must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipart/form-data"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v3~1{domain_name}~1whitelists~1import/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domainID-unsubscribes-import-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/POST-v3-domainID-unsubscribes-import-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1{domain_name}~1whitelists~1import/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/{domain_name}/whitelists/import","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"components/schemas/string"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domainID-unsubscribes-import-multipart-form-data-RequestBody"}},"responseCodes":["202","400","500"],"pointer":"/v3/{domain_name}/whitelists/import","href":"allowlist/post-v3--domainid--whitelists-import","openApiOperationId":"POST-v3--domainID--whitelists-import","summary":"Import allowlist"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/POST-v3-domainID-unsubscribes-import-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domainID-unsubscribes-import-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"A 202 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1import/post/responses/202/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1import/post/responses/202/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1import/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1import/post/responses/400/content/application~1json/examples/Example"]},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1import/post/responses/500/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1import/post/responses/500/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain_name}~1whitelists~1import/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1import/post/responses/202/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1import/post/responses/202/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1import/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1import/post/responses/400/content/application~1json/examples/Example"]}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1import/post/responses/500/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1import/post/responses/500/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/allowlist/post-v3--domainid--whitelists-import"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/whitelists/import"},{"label":"Lookup allowlist record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/allowlist/get-v3--domainid--whitelists--value-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/allowlist/get-v3--domainid--whitelists--value-","metadata":{"seo":{"title":"Lookup allowlist record","description":"Fetch a single allowlist record to check if a given address or domain is present."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3--domainID--whitelists--value-","name":"Lookup allowlist record","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1whitelists~1{value}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lookup allowlist record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch a single allowlist record to check if a given address or domain is present."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain to retrieve the allowlist entry from","required":true},{"name":"value","in":"path","schemaId":"components/schemas/string","description":"The address to search for","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1whitelists~1{value}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/{domain_name}/whitelists/{value}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"value","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/{domain_name}/whitelists/{value}","href":"allowlist/get-v3--domainid--whitelists--value-","openApiOperationId":"GET-v3--domainID--whitelists--value-","summary":"Lookup allowlist record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-model-Whitelist","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1{value}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-blackbook-model-Whitelist","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1{value}/get/responses/200/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1{value}/get/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1{value}/get/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain_name}~1whitelists~1{value}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-blackbook-model-Whitelist","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1{value}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-model-Whitelist","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1{value}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1{value}/get/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1{value}/get/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/allowlist/get-v3--domainid--whitelists--value-"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/whitelists/{value}"},{"label":"Remove entry from allowlist","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/allowlist/delete-v3--domainid--whitelists--value-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/allowlist/delete-v3--domainid--whitelists--value-","metadata":{"seo":{"title":"Remove entry from allowlist","description":"Remove a single entry from the allowlist"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3--domainID--whitelists--value-","name":"Remove entry from allowlist","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1whitelists~1{value}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove entry from allowlist","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove a single entry from the allowlist"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain to delete the allowlist entry from","required":true},{"name":"value","in":"path","schemaId":"components/schemas/string","description":"The address to remove","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1whitelists~1{value}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/{domain_name}/whitelists/{value}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"value","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/{domain_name}/whitelists/{value}","href":"allowlist/delete-v3--domainid--whitelists--value-","openApiOperationId":"DELETE-v3--domainID--whitelists--value-","summary":"Remove entry from allowlist"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-deleteWhitelistRecordResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1{value}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-blackbook-api-deleteWhitelistRecordResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1{value}/delete/responses/200/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1{value}/delete/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1{value}/delete/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain_name}~1whitelists~1{value}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-blackbook-api-deleteWhitelistRecordResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1{value}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-deleteWhitelistRecordResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1{value}/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1{value}/delete/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists~1{value}/delete/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/allowlist/delete-v3--domainid--whitelists--value-"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/whitelists/{value}"},{"label":"List allowlist records for domain","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/allowlist/get-v3--domainid--whitelists","routeSlug":"/docs/mailgun/api-reference/send/mailgun/allowlist/get-v3--domainid--whitelists","metadata":{"seo":{"title":"List allowlist records for domain","description":"Paginate over all allowlist records for a domain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3--domainID--whitelists","name":"List allowlist records for domain","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1whitelists/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List allowlist records for domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Paginate over  all allowlist records for a domain."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain to retrieve allowlist entries from","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1whitelists/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_260","description":"Maximum number of records to return (optional, default: 100, max: 1000)"},{"name":"page","in":"query","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page direction relative to the above address, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if empty, returns the first page"},"children":[]}]}]}]},{"name":"address","in":"query","schemaId":"components/schemas/string","description":"address serving as a \"divider\" between pages","required":true},{"name":"term","in":"query","schemaId":"components/schemas/string","description":"Filter records based on addresses that start with the specified substring.","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1whitelists/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/{domain_name}/whitelists","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"limit","in":"query","schemaId":"schema_260"},{"name":"page","in":"query","schemaId":"components/schemas/string"},{"name":"address","in":"query","required":true,"schemaId":"components/schemas/string"},{"name":"term","in":"query","required":true,"schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/{domain_name}/whitelists","href":"allowlist/get-v3--domainid--whitelists","openApiOperationId":"GET-v3--domainID--whitelists","summary":"List allowlist records for domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-getWhitelistPaginationResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-blackbook-api-getWhitelistPaginationResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1{domain_name}~1whitelists/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-blackbook-api-getWhitelistPaginationResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-getWhitelistPaginationResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/allowlist/get-v3--domainid--whitelists"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/whitelists"},{"label":"Add allowlist record","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/allowlist/post-v3--domainid--whitelists","routeSlug":"/docs/mailgun/api-reference/send/mailgun/allowlist/post-v3--domainid--whitelists","metadata":{"seo":{"title":"Add allowlist record","description":"Add an address or domain to the allowlist table"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3--domainID--whitelists","name":"Add allowlist record","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1whitelists/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add allowlist record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add an address or domain to the allowlist table"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain to add the allowlist entry to","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1whitelists/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/form-data"],"mediaTypeSchemas":{"application/form-data":{"schemaId":"components/schemas/POST-v3-domainID-whitelists-application-form-data-RequestBody"}},"schemaId":"components/schemas/POST-v3-domainID-whitelists-application-form-data-RequestBody","pointer":"/paths/~1v3~1{domain_name}~1whitelists/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/{domain_name}/whitelists","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/form-data":{"schemaId":"components/schemas/POST-v3-domainID-whitelists-application-form-data-RequestBody"}},"responseCodes":["200","400"],"pointer":"/v3/{domain_name}/whitelists","href":"allowlist/post-v3--domainid--whitelists","openApiOperationId":"POST-v3--domainID--whitelists","summary":"Add allowlist record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/POST-v3-domainID-whitelists-application-form-data-RequestBody","mediaTypes":["application/form-data"],"mediaTypeSchemas":{"application/form-data":{"schemaId":"components/schemas/POST-v3-domainID-whitelists-application-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-insertWhitelistRecordResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-blackbook-api-insertWhitelistRecordResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists/post/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1{domain_name}~1whitelists/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-blackbook-api-insertWhitelistRecordResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-blackbook-api-insertWhitelistRecordResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists/post/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/allowlist/post-v3--domainid--whitelists"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/whitelists"},{"label":"Clear allowlist","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/allowlist/delete-v3--domainid--whitelists","routeSlug":"/docs/mailgun/api-reference/send/mailgun/allowlist/delete-v3--domainid--whitelists","metadata":{"seo":{"title":"Clear allowlist","description":"Delete an entire allowlist for a domain"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3--domainID--whitelists","name":"Clear allowlist","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1whitelists/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clear allowlist","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete an entire allowlist for a domain"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain to delete allowlist entries from","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1whitelists/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/{domain_name}/whitelists","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/{domain_name}/whitelists","href":"allowlist/delete-v3--domainid--whitelists","openApiOperationId":"DELETE-v3--domainID--whitelists","summary":"Clear allowlist"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists/delete/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1{domain_name}~1whitelists/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1whitelists/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/allowlist/delete-v3--domainid--whitelists"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/whitelists"}],"content":{"contentType":"group","meta":{"name":"Allowlist"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Allowlist","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The allowlist API provides the ability to allowlist specific addresses from being added to bounce list. You can allowlist by domain name (i.e example.com) or by specific address (i.e. alice@example.com). Mailgun doesn’t add an address to bounce list if the address is allowlisted. This API is very useful if you test against your private services and don’t want to constantly clean up bounce lists"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/{domain_name}/whitelists/import","summary":"Import allowlist","prefix":{"name":"post","color":"post"},"badges":[],"link":"/allowlist/post-v3--domainid--whitelists-import","deprecated":false},{"title":"/v3/{domain_name}/whitelists/{value}","summary":"Lookup allowlist record","prefix":{"name":"get","color":"get"},"badges":[],"link":"/allowlist/get-v3--domainid--whitelists--value-","deprecated":false},{"title":"/v3/{domain_name}/whitelists/{value}","summary":"Remove entry from allowlist","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/allowlist/delete-v3--domainid--whitelists--value-","deprecated":false},{"title":"/v3/{domain_name}/whitelists","summary":"List allowlist records for domain","prefix":{"name":"get","color":"get"},"badges":[],"link":"/allowlist/get-v3--domainid--whitelists","deprecated":false},{"title":"/v3/{domain_name}/whitelists","summary":"Add allowlist record","prefix":{"name":"post","color":"post"},"badges":[],"link":"/allowlist/post-v3--domainid--whitelists","deprecated":false},{"title":"/v3/{domain_name}/whitelists","summary":"Clear allowlist","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/allowlist/delete-v3--domainid--whitelists","deprecated":false}]}]}]}]}},{"type":"separator","label":"Receiving","content":null},{"type":"group","label":"Routes","link":"/docs/mailgun/api-reference/send/mailgun/routes","routeSlug":"/docs/mailgun/api-reference/send/mailgun/routes","items":[{"label":"Create a route","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/routes/post-v3-routes","routeSlug":"/docs/mailgun/api-reference/send/mailgun/routes/post-v3-routes","metadata":{"seo":{"title":"Create a route","description":"Adds a new route to the account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-v3-routes","name":"Create a route","isWebhook":false,"pointer":"/paths/~1v3~1routes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a new route to the account"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_269","exampleIds":["paths/~1v3~1routes/post/requestBody/content/application~1x-www-form-urlencoded/examples/Example"]}},"schemaId":"schema_269","exampleIds":["paths/~1v3~1routes/post/requestBody/content/application~1x-www-form-urlencoded/examples/Example"],"pointer":"/paths/~1v3~1routes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/routes","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_269","exampleIds":["paths/~1v3~1routes/post/requestBody/content/application~1x-www-form-urlencoded/examples/Example"]}},"responseCodes":["200"],"pointer":"/v3/routes","href":"routes/post-v3-routes","openApiOperationId":"post-v3-routes","summary":"Create a route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"schema_269","exampleIds":["paths/~1v3~1routes/post/requestBody/content/application~1x-www-form-urlencoded/examples/Example"],"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_269","exampleIds":["paths/~1v3~1routes/post/requestBody/content/application~1x-www-form-urlencoded/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_270","exampleIds":["paths/~1v3~1routes/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"schema_270","exampleIds":["paths/~1v3~1routes/post/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1routes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_270","exampleIds":["paths/~1v3~1routes/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_270","exampleIds":["paths/~1v3~1routes/post/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/routes/post-v3-routes"}],"panels":[]}]},"httpPath":"/v3/routes"},{"label":"Get all routes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/routes/get-v3-routes","routeSlug":"/docs/mailgun/api-reference/send/mailgun/routes/get-v3-routes","metadata":{"seo":{"title":"Get all routes","description":"Get the list of routes. Note that routes are defined globally, per account, not per domain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-v3-routes","name":"Get all routes","isWebhook":false,"pointer":"/paths/~1v3~1routes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all routes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the list of routes. Note that routes are defined globally, per account, not per domain."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"skip","in":"query","schemaId":"components/schemas/string","description":"Number of records to skip. Defaults to 0."},{"name":"limit","in":"query","schemaId":"components/schemas/string","description":"Maximum number of records to return. Defaults to 100."}],"pointer":"/paths/~1v3~1routes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/routes","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"skip","in":"query","schemaId":"components/schemas/string"},{"name":"limit","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/routes","href":"routes/get-v3-routes","openApiOperationId":"get-v3-routes","summary":"Get all routes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_271","exampleIds":["paths/~1v3~1routes/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"schema_271","exampleIds":["paths/~1v3~1routes/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_272","exampleIds":["paths/~1v3~1routes/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"schema_272","exampleIds":["paths/~1v3~1routes/get/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1routes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_271","exampleIds":["paths/~1v3~1routes/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_271","exampleIds":["paths/~1v3~1routes/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"schema_272","exampleIds":["paths/~1v3~1routes/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_272","exampleIds":["paths/~1v3~1routes/get/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/routes/get-v3-routes"}],"panels":[]}]},"httpPath":"/v3/routes"},{"label":"Get a route","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/routes/get-v3-routes-id","routeSlug":"/docs/mailgun/api-reference/send/mailgun/routes/get-v3-routes-id","metadata":{"seo":{"title":"Get a route","description":"Returns a detailed view of the route"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-v3-routes-id","name":"Get a route","isWebhook":false,"pointer":"/paths/~1v3~1routes~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a detailed view of the route"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/string","description":"The unique identifier of the route","required":true}],"pointer":"/paths/~1v3~1routes~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/routes/{id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/routes/{id}","href":"routes/get-v3-routes-id","openApiOperationId":"get-v3-routes-id","summary":"Get a route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_273","exampleIds":["paths/~1v3~1routes~1{id}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"schema_273","exampleIds":["paths/~1v3~1routes~1{id}/get/responses/200/content/application~1json/examples/Example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_272","exampleIds":["paths/~1v3~1routes~1{id}/get/responses/404/content/application~1json/examples/Example"]}},"schemaId":"schema_272","exampleIds":["paths/~1v3~1routes~1{id}/get/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1routes~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_273","exampleIds":["paths/~1v3~1routes~1{id}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_273","exampleIds":["paths/~1v3~1routes~1{id}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"schema_272","exampleIds":["paths/~1v3~1routes~1{id}/get/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_272","exampleIds":["paths/~1v3~1routes~1{id}/get/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/routes/get-v3-routes-id"}],"panels":[]}]},"httpPath":"/v3/routes/{id}"},{"label":"Update a route","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/routes/put-v3-routes-id","routeSlug":"/docs/mailgun/api-reference/send/mailgun/routes/put-v3-routes-id","metadata":{"seo":{"title":"Update a route","description":"Updates a given route. All parameters are optional. This only updates the specified fields, leaving others unchanged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-v3-routes-id","name":"Update a route","isWebhook":false,"pointer":"/paths/~1v3~1routes~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a given route. All parameters are optional. This only updates the specified fields, leaving others unchanged."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/string","description":"ID of the route","required":true}],"pointer":"/paths/~1v3~1routes~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_274","exampleIds":["paths/~1v3~1routes~1{id}/put/requestBody/content/application~1x-www-form-urlencoded/examples/Example"]}},"schemaId":"schema_274","exampleIds":["paths/~1v3~1routes~1{id}/put/requestBody/content/application~1x-www-form-urlencoded/examples/Example"],"pointer":"/paths/~1v3~1routes~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/routes/{id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_274","exampleIds":["paths/~1v3~1routes~1{id}/put/requestBody/content/application~1x-www-form-urlencoded/examples/Example"]}},"responseCodes":["200","404"],"pointer":"/v3/routes/{id}","href":"routes/put-v3-routes-id","openApiOperationId":"put-v3-routes-id","summary":"Update a route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"schema_274","exampleIds":["paths/~1v3~1routes~1{id}/put/requestBody/content/application~1x-www-form-urlencoded/examples/Example"],"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_274","exampleIds":["paths/~1v3~1routes~1{id}/put/requestBody/content/application~1x-www-form-urlencoded/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_275","exampleIds":["paths/~1v3~1routes~1{id}/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"schema_275","exampleIds":["paths/~1v3~1routes~1{id}/put/responses/200/content/application~1json/examples/Example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_272","exampleIds":["paths/~1v3~1routes~1{id}/put/responses/404/content/application~1json/examples/Example"]}},"schemaId":"schema_272","exampleIds":["paths/~1v3~1routes~1{id}/put/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1routes~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_275","exampleIds":["paths/~1v3~1routes~1{id}/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_275","exampleIds":["paths/~1v3~1routes~1{id}/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"schema_272","exampleIds":["paths/~1v3~1routes~1{id}/put/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_272","exampleIds":["paths/~1v3~1routes~1{id}/put/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/routes/put-v3-routes-id"}],"panels":[]}]},"httpPath":"/v3/routes/{id}"},{"label":"Delete a route","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/routes/delete-v3-routes-id","routeSlug":"/docs/mailgun/api-reference/send/mailgun/routes/delete-v3-routes-id","metadata":{"seo":{"title":"Delete a route","description":"Remove the rotue from the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-v3-routes-id","name":"Delete a route","isWebhook":false,"pointer":"/paths/~1v3~1routes~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove the rotue from the account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/string","description":"ID of the route","required":true}],"pointer":"/paths/~1v3~1routes~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/routes/{id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/routes/{id}","href":"routes/delete-v3-routes-id","openApiOperationId":"delete-v3-routes-id","summary":"Delete a route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_276","exampleIds":["paths/~1v3~1routes~1{id}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"schema_276","exampleIds":["paths/~1v3~1routes~1{id}/delete/responses/200/content/application~1json/examples/Example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_277","exampleIds":["paths/~1v3~1routes~1{id}/delete/responses/404/content/application~1json/examples/Example"]}},"schemaId":"schema_277","exampleIds":["paths/~1v3~1routes~1{id}/delete/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1routes~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_276","exampleIds":["paths/~1v3~1routes~1{id}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_276","exampleIds":["paths/~1v3~1routes~1{id}/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"schema_277","exampleIds":["paths/~1v3~1routes~1{id}/delete/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_277","exampleIds":["paths/~1v3~1routes~1{id}/delete/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/routes/delete-v3-routes-id"}],"panels":[]}]},"httpPath":"/v3/routes/{id}"},{"label":"Match address to route","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/routes/get-v3-routes-match","routeSlug":"/docs/mailgun/api-reference/send/mailgun/routes/get-v3-routes-match","metadata":{"seo":{"title":"Match address to route","description":"Checks if an address matches at least one route."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-v3-routes-match","name":"Match address to route","isWebhook":false,"pointer":"/paths/~1v3~1routes~1match/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Match address to route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Checks if an address matches at least one route."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"address","in":"query","schemaId":"components/schemas/string","description":"address to match routes on","required":true}],"pointer":"/paths/~1v3~1routes~1match/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/routes/match","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"address","in":"query","required":true,"schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/routes/match","href":"routes/get-v3-routes-match","openApiOperationId":"get-v3-routes-match","summary":"Match address to route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_273","exampleIds":["paths/~1v3~1routes~1match/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"schema_273","exampleIds":["paths/~1v3~1routes~1match/get/responses/200/content/application~1json/examples/Example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_272","exampleIds":["paths/~1v3~1routes~1match/get/responses/404/content/application~1json/examples/Example"]}},"schemaId":"schema_272","exampleIds":["paths/~1v3~1routes~1match/get/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1routes~1match/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_273","exampleIds":["paths/~1v3~1routes~1match/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_273","exampleIds":["paths/~1v3~1routes~1match/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"schema_272","exampleIds":["paths/~1v3~1routes~1match/get/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_272","exampleIds":["paths/~1v3~1routes~1match/get/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/routes/get-v3-routes-match"}],"panels":[]}]},"httpPath":"/v3/routes/match"}],"content":{"contentType":"group","meta":{"name":"Routes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Routes","showPageActions":true},{"nodeType":"markdoc","content":"Define a list of routes to handle incoming emails. When a message matches a route expression, Mailgun can forward it on to your application via HTTP or another email address, or store the message temporarily (3 days) for subsequent retrieval."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/routes","summary":"Create a route","prefix":{"name":"post","color":"post"},"badges":[],"link":"/routes/post-v3-routes","deprecated":false},{"title":"/v3/routes","summary":"Get all routes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/routes/get-v3-routes","deprecated":false},{"title":"/v3/routes/{id}","summary":"Get a route","prefix":{"name":"get","color":"get"},"badges":[],"link":"/routes/get-v3-routes-id","deprecated":false},{"title":"/v3/routes/{id}","summary":"Update a route","prefix":{"name":"put","color":"put"},"badges":[],"link":"/routes/put-v3-routes-id","deprecated":false},{"title":"/v3/routes/{id}","summary":"Delete a route","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/routes/delete-v3-routes-id","deprecated":false},{"title":"/v3/routes/match","summary":"Match address to route","prefix":{"name":"get","color":"get"},"badges":[],"link":"/routes/get-v3-routes-match","deprecated":false}]}]}]}]}},{"type":"group","label":"Forwards","link":"/docs/mailgun/api-reference/send/mailgun/forwards","routeSlug":"/docs/mailgun/api-reference/send/mailgun/forwards","items":[{"label":"Get a single forward rule by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/forwards/get-v3-forwards--id-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/forwards/get-v3-forwards--id-","metadata":{"seo":{"title":"Get a single forward rule by ID","description":"Retrieve a forward rule by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-forwards--id-","name":"Get a single forward rule by ID","isWebhook":false,"pointer":"/paths/~1v3~1forwards~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a single forward rule by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a forward rule by ID"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/string","description":"The ID of the forward rule","required":true}],"pointer":"/paths/~1v3~1forwards~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/forwards/{id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v3/forwards/{id}","href":"forwards/get-v3-forwards--id-","openApiOperationId":"GET-v3-forwards--id-","summary":"Get a single forward rule by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-pathfinder-httpapi-ForwardsRule","exampleIds":["paths/~1v3~1forwards~1{id}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-pathfinder-httpapi-ForwardsRule","exampleIds":["paths/~1v3~1forwards~1{id}/get/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1forwards~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-pathfinder-httpapi-ForwardsRule","exampleIds":["paths/~1v3~1forwards~1{id}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-pathfinder-httpapi-ForwardsRule","exampleIds":["paths/~1v3~1forwards~1{id}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/forwards/get-v3-forwards--id-"}],"panels":[]}]},"httpPath":"/v3/forwards/{id}"},{"label":"Update a single forward rule by ID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/forwards/put-v3-forwards--id-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/forwards/put-v3-forwards--id-","metadata":{"seo":{"title":"Update a single forward rule by ID","description":"All parameters are optional, only the provided fields will be updated"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v3-forwards--id-","name":"Update a single forward rule by ID","isWebhook":false,"pointer":"/paths/~1v3~1forwards~1{id}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a single forward rule by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"All parameters are optional, only the provided fields will be updated"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/string","description":"The ID of the forward rule","required":true}],"pointer":"/paths/~1v3~1forwards~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"match","in":"query","schemaId":"components/schemas/string","description":"A wildcard expression which matches the recipient address to forward. This is a insensitive match address","required":true},{"name":"forward.url","in":"query","schemaId":"components/schemas/string","description":"A URL to forward when the rule matches the recipient. May be repeated up to 3 times. Must be a valid URL that resolves","required":true},{"name":"forward.recipient","in":"query","schemaId":"components/schemas/string","description":"A email address to forward to when the rule matches the recipient. May be repeated up to 5 times","required":true},{"name":"forward.store","in":"query","schemaId":"components/schemas/string","description":"A URL which will be used to notify you when the email arrives along with a URL you can use to retrieve the message. Must be a valid URL that resolves","required":true}],"pointer":"/paths/~1v3~1forwards~1{id}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/forwards/{id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"match","in":"query","required":true,"schemaId":"components/schemas/string"},{"name":"forward.url","in":"query","required":true,"schemaId":"components/schemas/string"},{"name":"forward.recipient","in":"query","required":true,"schemaId":"components/schemas/string"},{"name":"forward.store","in":"query","required":true,"schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v3/forwards/{id}","href":"forwards/put-v3-forwards--id-","openApiOperationId":"PUT-v3-forwards--id-","summary":"Update a single forward rule by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-pathfinder-httpapi-ForwardsRule","exampleIds":["paths/~1v3~1forwards~1{id}/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-pathfinder-httpapi-ForwardsRule","exampleIds":["paths/~1v3~1forwards~1{id}/put/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1forwards~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-pathfinder-httpapi-ForwardsRule","exampleIds":["paths/~1v3~1forwards~1{id}/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-pathfinder-httpapi-ForwardsRule","exampleIds":["paths/~1v3~1forwards~1{id}/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/forwards/put-v3-forwards--id-"}],"panels":[]}]},"httpPath":"/v3/forwards/{id}"},{"label":"Delete a single forward rule by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/forwards/delete-v3-forwards--id-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/forwards/delete-v3-forwards--id-","metadata":{"seo":{"title":"Delete a single forward rule by ID","description":"By default this call is scoped to the entire account. You can scope the request by providing the 'domain.name' query parameter. If the 'domain.name' parameter is provided and the requested rule is not defined for that domain the call will return 404 Not Found"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3-forwards--id-","name":"Delete a single forward rule by ID","isWebhook":false,"pointer":"/paths/~1v3~1forwards~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a single forward rule by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"By default this call is scoped to the entire account. You can scope the request by providing the 'domain.name' query parameter. If the 'domain.name' parameter is provided and the requested rule is not defined for that domain the call will return 404 Not Found"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/string","description":"The ID of the forward rule","required":true}],"pointer":"/paths/~1v3~1forwards~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"domain.name","in":"query","schemaId":"components/schemas/string","description":"The name of the domain the rule is scoped to"}],"pointer":"/paths/~1v3~1forwards~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/forwards/{id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"domain.name","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v3/forwards/{id}","href":"forwards/delete-v3-forwards--id-","openApiOperationId":"DELETE-v3-forwards--id-","summary":"Delete a single forward rule by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1forwards~1{id}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1forwards~1{id}/delete/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1forwards~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1forwards~1{id}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1forwards~1{id}/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/forwards/delete-v3-forwards--id-"}],"panels":[]}]},"httpPath":"/v3/forwards/{id}"},{"label":"List forward rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/forwards/get-v3-forwards","routeSlug":"/docs/mailgun/api-reference/send/mailgun/forwards/get-v3-forwards","metadata":{"seo":{"title":"List forward rules","description":"By default this endpoint lists all rules defined on the account. You can scope the list of rules by domain by providing the 'domain.name' query parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-forwards","name":"List forward rules","isWebhook":false,"pointer":"/paths/~1v3~1forwards/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List forward rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"By default this endpoint lists all rules defined on the account. You can scope the list of rules by domain by providing the 'domain.name' query parameter."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"components/schemas/string","description":"Encoded paging information, provided via 'next', 'previous' links","required":true},{"name":"limit","in":"query","schemaId":"schema_260","description":"Limits the number of items returned in a request","required":true},{"name":"domain.name","in":"query","schemaId":"components/schemas/string","description":"The name of the domain the rule is scoped to"}],"pointer":"/paths/~1v3~1forwards/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/forwards","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":true,"schemaId":"components/schemas/string"},{"name":"limit","in":"query","required":true,"schemaId":"schema_260"},{"name":"domain.name","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/v3/forwards","href":"forwards/get-v3-forwards","openApiOperationId":"GET-v3-forwards","summary":"List forward rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-pathfinder-httpapi-ListForwardsRulesResp","exampleIds":["paths/~1v3~1forwards/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-pathfinder-httpapi-ListForwardsRulesResp","exampleIds":["paths/~1v3~1forwards/get/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1forwards/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-pathfinder-httpapi-ListForwardsRulesResp","exampleIds":["paths/~1v3~1forwards/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-pathfinder-httpapi-ListForwardsRulesResp","exampleIds":["paths/~1v3~1forwards/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/forwards/get-v3-forwards"}],"panels":[]}]},"httpPath":"/v3/forwards"},{"label":"Create a forward rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/forwards/post-v3-forwards","routeSlug":"/docs/mailgun/api-reference/send/mailgun/forwards/post-v3-forwards","metadata":{"seo":{"title":"Create a forward rule","description":"Examples"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3-forwards","name":"Create a forward rule","isWebhook":false,"pointer":"/paths/~1v3~1forwards/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a forward rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"forwards/post-v3-forwards/request/examples","deepLinkHash":"/forwards/post-v3-forwards#forwards/post-v3-forwards/request/examples"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add multiple email recipients by including the 'forward.recipient' parameter multiple times up to a maximum of 5."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"$ curl -X POST https://api.mailgun.net/v3/forwards\n  -F match='email@mg.example.com'\n  -F forward.recipient=destination1@gmail.com\n  -F forward.recipient=destination2@gmail.com\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"$ curl -X POST https://api.mailgun.net/v3/forwards\n  -F match='email@mg.example.com'\n  -F forward.recipient=destination1@gmail.com\n  -F forward.recipient=destination2@gmail.com\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"match"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter can contain a wild card expression"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"$ curl -X POST https://api.mailgun.net/v3/forwards\n  -F match='match*@mg.example.com'\n  -F forward.recipient=catchall@gmail.com\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"$ curl -X POST https://api.mailgun.net/v3/forwards\n  -F match='match*@mg.example.com'\n  -F forward.recipient=catchall@gmail.com\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rules only support "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or literal characters where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matches any sequence of characters.  So "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"a.*@example.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matches email addresses that start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"a."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" not email addresses that start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"a"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" like a regex match would."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"match","in":"query","schemaId":"components/schemas/string","description":"A wildcard expression which matches the recipient address to forward. This is a insensitive match address","required":true},{"name":"forward.url","in":"query","schemaId":"components/schemas/string","description":"A URL to forward when the rule matches the recipient. May be repeated up to 3 times. Must be a valid URL that resolves","required":true},{"name":"forward.recipient","in":"query","schemaId":"components/schemas/string","description":"A email address to forward to when the rule matches the recipient. May be repeated up to 5 times","required":true},{"name":"forward.store","in":"query","schemaId":"components/schemas/string","description":"A URL which will be used to notify you when the email arrives along with a URL you can use to retrieve the message. Must be a valid URL that resolves","required":true}],"pointer":"/paths/~1v3~1forwards/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/forwards","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"match","in":"query","required":true,"schemaId":"components/schemas/string"},{"name":"forward.url","in":"query","required":true,"schemaId":"components/schemas/string"},{"name":"forward.recipient","in":"query","required":true,"schemaId":"components/schemas/string"},{"name":"forward.store","in":"query","required":true,"schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v3/forwards","href":"forwards/post-v3-forwards","openApiOperationId":"POST-v3-forwards","summary":"Create a forward rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-pathfinder-httpapi-ForwardsRule","exampleIds":["paths/~1v3~1forwards/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-pathfinder-httpapi-ForwardsRule","exampleIds":["paths/~1v3~1forwards/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1forwards/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-pathfinder-httpapi-ForwardsRule","exampleIds":["paths/~1v3~1forwards/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-pathfinder-httpapi-ForwardsRule","exampleIds":["paths/~1v3~1forwards/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/forwards/post-v3-forwards"}],"panels":[]}]},"httpPath":"/v3/forwards"}],"content":{"contentType":"group","meta":{"name":"Forwards"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Forwards","showPageActions":true},{"nodeType":"markdoc","content":"This API allows you to manage forwarding of incoming emails."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/forwards/{id}","summary":"Get a single forward rule by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/forwards/get-v3-forwards--id-","deprecated":false},{"title":"/v3/forwards/{id}","summary":"Update a single forward rule by ID","prefix":{"name":"put","color":"put"},"badges":[],"link":"/forwards/put-v3-forwards--id-","deprecated":false},{"title":"/v3/forwards/{id}","summary":"Delete a single forward rule by ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/forwards/delete-v3-forwards--id-","deprecated":false},{"title":"/v3/forwards","summary":"List forward rules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/forwards/get-v3-forwards","deprecated":false},{"title":"/v3/forwards","summary":"Create a forward rule","prefix":{"name":"post","color":"post"},"badges":[],"link":"/forwards/post-v3-forwards","deprecated":false}]}]}]}]}},{"type":"separator","label":"Mailing Lists","content":null},{"type":"group","label":"Mailing Lists","link":"/docs/mailgun/api-reference/send/mailgun/mailing-lists","routeSlug":"/docs/mailgun/api-reference/send/mailgun/mailing-lists","items":[{"label":"Create a mailing list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/post-v3-lists","routeSlug":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/post-v3-lists","metadata":{"seo":{"title":"Create a mailing list","description":"Adds a mailing list to the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-v3-lists","name":"Create a mailing list","isWebhook":false,"pointer":"/paths/~1v3~1lists/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a mailing list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a mailing list to the account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_278","exampleIds":["paths/~1v3~1lists/post/requestBody/content/multipart~1form-data/examples/Example"]}},"schemaId":"schema_278","exampleIds":["paths/~1v3~1lists/post/requestBody/content/multipart~1form-data/examples/Example"],"pointer":"/paths/~1v3~1lists/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/lists","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_278","exampleIds":["paths/~1v3~1lists/post/requestBody/content/multipart~1form-data/examples/Example"]}},"responseCodes":["201","400","429"],"pointer":"/v3/lists","href":"mailing-lists/post-v3-lists","openApiOperationId":"post-v3-lists","summary":"Create a mailing list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"schema_278","exampleIds":["paths/~1v3~1lists/post/requestBody/content/multipart~1form-data/examples/Example"],"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_278","exampleIds":["paths/~1v3~1lists/post/requestBody/content/multipart~1form-data/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Mailing list creation success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_279","exampleIds":["paths/~1v3~1lists/post/responses/201/content/application~1json/examples/Example"]}},"schemaId":"schema_279","exampleIds":["paths/~1v3~1lists/post/responses/201/content/application~1json/examples/Example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists/post/responses/400/content/application~1json/examples/Example 1","paths/~1v3~1lists/post/responses/400/content/application~1json/examples/Example 2"]}},"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists/post/responses/400/content/application~1json/examples/Example 1","paths/~1v3~1lists/post/responses/400/content/application~1json/examples/Example 2"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists/post/responses/429/content/application~1json/examples/Example"]}},"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists/post/responses/429/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1lists/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_279","exampleIds":["paths/~1v3~1lists/post/responses/201/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_279","exampleIds":["paths/~1v3~1lists/post/responses/201/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"schema_280","exampleIds":["paths/~1v3~1lists/post/responses/400/content/application~1json/examples/Example 1","paths/~1v3~1lists/post/responses/400/content/application~1json/examples/Example 2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists/post/responses/400/content/application~1json/examples/Example 1","paths/~1v3~1lists/post/responses/400/content/application~1json/examples/Example 2"]}}},{"code":"429","schemaId":"schema_280","exampleIds":["paths/~1v3~1lists/post/responses/429/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists/post/responses/429/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mailing-lists/post-v3-lists"}],"panels":[]}]},"httpPath":"/v3/lists"},{"label":"Get mailing lists","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-v3-lists","routeSlug":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-v3-lists","metadata":{"seo":{"title":"Get mailing lists","description":"A mailing list is a group of members (recipients) which itself has an email address. This address becomes an ID for this mailing list."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-v3-lists","name":"Get mailing lists","isWebhook":false,"pointer":"/paths/~1v3~1lists/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get mailing lists","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"A mailing list is a group of members (recipients) which itself has an email address. This address becomes an ID for this mailing list."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"components/schemas/string","description":"Set limit for the list length returned. Defaults to 100."},{"name":"skip","in":"query","schemaId":"components/schemas/string","description":"Skip the first n values in the list. Defaults to 0."},{"name":"address","in":"query","schemaId":"components/schemas/string","description":"Filter mailing lists matching a specific address"}],"pointer":"/paths/~1v3~1lists/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/lists","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"components/schemas/string"},{"name":"skip","in":"query","schemaId":"components/schemas/string"},{"name":"address","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/v3/lists","href":"mailing-lists/get-v3-lists","openApiOperationId":"get-v3-lists","summary":"Get mailing lists"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_281","exampleIds":["paths/~1v3~1lists/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"schema_281","exampleIds":["paths/~1v3~1lists/get/responses/200/content/application~1json/examples/Example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists/get/responses/429/content/application~1json/examples/Example"]}},"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists/get/responses/429/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1lists/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_281","exampleIds":["paths/~1v3~1lists/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_281","exampleIds":["paths/~1v3~1lists/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"429","schemaId":"schema_280","exampleIds":["paths/~1v3~1lists/get/responses/429/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists/get/responses/429/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mailing-lists/get-v3-lists"}],"panels":[]}]},"httpPath":"/v3/lists"},{"label":"Get mailing lists members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-lists-string:list_address-members","routeSlug":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-lists-string:list_address-members","metadata":{"seo":{"title":"Get mailing lists members","description":"Lists members in a given mailing list"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-lists-string:list_address-members","name":"Get mailing lists members","isWebhook":false,"pointer":"/paths/~1v3~1lists~1{list_address}~1members/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get mailing lists members","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists members in a given mailing list"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"list_address","in":"path","schemaId":"components/schemas/string","description":"The mailing list's address","required":true}],"pointer":"/paths/~1v3~1lists~1{list_address}~1members/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"address","in":"query","schemaId":"components/schemas/string","description":"A valid email address specification."},{"name":"subscribed","in":"query","schemaId":"schema_261","description":"Filtering list on whether the member is subscribed or not."},{"name":"limit","in":"query","schemaId":"schema_260","description":"Maximum number of records to return. Max is 100. Defaults to 100."},{"name":"skip","in":"query","schemaId":"schema_260"}],"pointer":"/paths/~1v3~1lists~1{list_address}~1members/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/lists/{list_address}/members","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"list_address","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"address","in":"query","schemaId":"components/schemas/string"},{"name":"subscribed","in":"query","schemaId":"schema_261"},{"name":"limit","in":"query","schemaId":"schema_260"},{"name":"skip","in":"query","schemaId":"schema_260"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/v3/lists/{list_address}/members","href":"mailing-lists/get-lists-string:list_address-members","openApiOperationId":"get-lists-string:list_address-members","summary":"Get mailing lists members"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_282","exampleIds":["paths/~1v3~1lists~1{list_address}~1members/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"schema_282","exampleIds":["paths/~1v3~1lists~1{list_address}~1members/get/responses/200/content/application~1json/examples/Example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members/get/responses/429/content/application~1json/examples/Example"]}},"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members/get/responses/429/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1lists~1{list_address}~1members/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_282","exampleIds":["paths/~1v3~1lists~1{list_address}~1members/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_282","exampleIds":["paths/~1v3~1lists~1{list_address}~1members/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"429","schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members/get/responses/429/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members/get/responses/429/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mailing-lists/get-lists-string:list_address-members"}],"panels":[]}]},"httpPath":"/v3/lists/{list_address}/members"},{"label":"Create a mailing list member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/post-lists-string:list_address-members","routeSlug":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/post-lists-string:list_address-members","metadata":{"seo":{"title":"Create a mailing list member","description":"Adds a new member to the mailing list.  For adding many list members, consider bulk upload endpoints \"POST /v3/lists/{list_address}/members.json\" or \"members.csv\"."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-lists-string:list_address-members","name":"Create a mailing list member","isWebhook":false,"pointer":"/paths/~1v3~1lists~1{list_address}~1members/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a mailing list member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a new member to the mailing list.  For adding many list members, consider bulk upload endpoints \"POST /v3/lists/{list_address}/members.json\" or \"members.csv\"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"list_address","in":"path","schemaId":"components/schemas/string","description":"The mailing list's address","required":true}],"pointer":"/paths/~1v3~1lists~1{list_address}~1members/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_283","exampleIds":["paths/~1v3~1lists~1{list_address}~1members/post/requestBody/content/multipart~1form-data/examples/Example"]}},"schemaId":"schema_283","exampleIds":["paths/~1v3~1lists~1{list_address}~1members/post/requestBody/content/multipart~1form-data/examples/Example"],"pointer":"/paths/~1v3~1lists~1{list_address}~1members/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/lists/{list_address}/members","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"list_address","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_283","exampleIds":["paths/~1v3~1lists~1{list_address}~1members/post/requestBody/content/multipart~1form-data/examples/Example"]}},"responseCodes":["200","400","429"],"pointer":"/v3/lists/{list_address}/members","href":"mailing-lists/post-lists-string:list_address-members","openApiOperationId":"post-lists-string:list_address-members","summary":"Create a mailing list member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"schema_283","exampleIds":["paths/~1v3~1lists~1{list_address}~1members/post/requestBody/content/multipart~1form-data/examples/Example"],"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_283","exampleIds":["paths/~1v3~1lists~1{list_address}~1members/post/requestBody/content/multipart~1form-data/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_284","exampleIds":["paths/~1v3~1lists~1{list_address}~1members/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"schema_284","exampleIds":["paths/~1v3~1lists~1{list_address}~1members/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members/post/responses/400/content/application~1json/examples/Example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members/post/responses/429/content/application~1json/examples/Example"]}},"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members/post/responses/429/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1lists~1{list_address}~1members/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_284","exampleIds":["paths/~1v3~1lists~1{list_address}~1members/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_284","exampleIds":["paths/~1v3~1lists~1{list_address}~1members/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members/post/responses/400/content/application~1json/examples/Example"]}}},{"code":"429","schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members/post/responses/429/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members/post/responses/429/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mailing-lists/post-lists-string:list_address-members"}],"panels":[]}]},"httpPath":"/v3/lists/{list_address}/members"},{"label":"Bulk upload members to a mailing list (JSON)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/post-lists-list_address-members.json","routeSlug":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/post-lists-list_address-members.json","metadata":{"seo":{"title":"Bulk upload members to a mailing list (JSON)","description":"Adds multiple members, up to 1000 per call, to a mailing list, using JSON array format. If the request includes more than 100 entries, the mailing list will be updated asynchronously."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-lists-list_address-members.json","name":"Bulk upload members to a mailing list (JSON)","isWebhook":false,"pointer":"/paths/~1v3~1lists~1{list_address}~1members.json/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk upload members to a mailing list (JSON)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds multiple members, up to 1000 per call, to a mailing list, using JSON array format.\nIf the request includes more than 100 entries, the mailing list will be updated asynchronously.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"list_address","in":"path","schemaId":"components/schemas/string","description":"The mailing list's address","required":true}],"pointer":"/paths/~1v3~1lists~1{list_address}~1members.json/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"members","in":"query","schemaId":"schema_285","description":"Mailing list recipients in JSON array format. Can be, either, an array of string addresses or an array of ListMemberRequest JSON objects.","required":true},{"name":"upsert","in":"query","schemaId":"schema_261","description":"If true, an existing member will be updated. Defaults to false."}],"pointer":"/paths/~1v3~1lists~1{list_address}~1members.json/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/lists/{list_address}/members.json","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"list_address","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"members","in":"query","required":true,"schemaId":"schema_285"},{"name":"upsert","in":"query","required":false,"schemaId":"schema_261"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404","429"],"pointer":"/v3/lists/{list_address}/members.json","href":"mailing-lists/post-lists-list_address-members.json","openApiOperationId":"post-lists-list_address-members.json","summary":"Bulk upload members to a mailing list (JSON)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_286","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.json/post/responses/200/content/application~1json/examples/Async update"]}},"schemaId":"schema_286","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.json/post/responses/200/content/application~1json/examples/Async update"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.json/post/responses/404/content/application~1json/examples/Example"]}},"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.json/post/responses/404/content/application~1json/examples/Example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.json/post/responses/429/content/application~1json/examples/Example"]}},"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.json/post/responses/429/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1lists~1{list_address}~1members.json/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_286","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.json/post/responses/200/content/application~1json/examples/Async update"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_286","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.json/post/responses/200/content/application~1json/examples/Async update"]}}},{"code":"404","schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.json/post/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.json/post/responses/404/content/application~1json/examples/Example"]}}},{"code":"429","schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.json/post/responses/429/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.json/post/responses/429/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mailing-lists/post-lists-list_address-members.json"}],"panels":[]}]},"httpPath":"/v3/lists/{list_address}/members.json"},{"label":"Bulk upload members to a mailing list (CSV)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/post-lists-list_address-members.csv","routeSlug":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/post-lists-list_address-members.csv","metadata":{"seo":{"title":"Bulk upload members to a mailing list (CSV)","description":"Adds multiple members, up to 1000 per call, to a mailing list via CSV file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-lists-list_address-members.csv","name":"Bulk upload members to a mailing list (CSV)","isWebhook":false,"pointer":"/paths/~1v3~1lists~1{list_address}~1members.csv/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk upload members to a mailing list (CSV)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds multiple members, up to 1000 per call, to a mailing list via CSV file."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"list_address","in":"path","schemaId":"components/schemas/string","description":"The mailing list's address","required":true}],"pointer":"/paths/~1v3~1lists~1{list_address}~1members.csv/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_287","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.csv/post/requestBody/content/multipart~1form-data/examples/Example"]}},"schemaId":"schema_287","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.csv/post/requestBody/content/multipart~1form-data/examples/Example"],"pointer":"/paths/~1v3~1lists~1{list_address}~1members.csv/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/lists/{list_address}/members.csv","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"list_address","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_287","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.csv/post/requestBody/content/multipart~1form-data/examples/Example"]}},"responseCodes":["200","400","404","429"],"pointer":"/v3/lists/{list_address}/members.csv","href":"mailing-lists/post-lists-list_address-members.csv","openApiOperationId":"post-lists-list_address-members.csv","summary":"Bulk upload members to a mailing list (CSV)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"schema_287","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.csv/post/requestBody/content/multipart~1form-data/examples/Example"],"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_287","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.csv/post/requestBody/content/multipart~1form-data/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_286","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.csv/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"schema_286","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.csv/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.csv/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.csv/post/responses/400/content/application~1json/examples/Example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.csv/post/responses/404/content/application~1json/examples/Example"]}},"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.csv/post/responses/404/content/application~1json/examples/Example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.csv/post/responses/429/content/application~1json/examples/Example"]}},"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.csv/post/responses/429/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1lists~1{list_address}~1members.csv/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_286","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.csv/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_286","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.csv/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.csv/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.csv/post/responses/400/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.csv/post/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.csv/post/responses/404/content/application~1json/examples/Example"]}}},{"code":"429","schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.csv/post/responses/429/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members.csv/post/responses/429/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mailing-lists/post-lists-list_address-members.csv"}],"panels":[]}]},"httpPath":"/v3/lists/{list_address}/members.csv"},{"label":"Get a member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-lists-list_address-members-member_address","routeSlug":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-lists-list_address-members-member_address","metadata":{"seo":{"title":"Get a member","description":"Get details about a specific mailing list member"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-lists-list_address-members-member_address","name":"Get a member","isWebhook":false,"pointer":"/paths/~1v3~1lists~1{list_address}~1members~1{member_address}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get details about a specific mailing list member"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"list_address","in":"path","schemaId":"components/schemas/string","description":"The mailing list's address","required":true},{"name":"member_address","in":"path","schemaId":"components/schemas/string","description":"The member's address","required":true}],"pointer":"/paths/~1v3~1lists~1{list_address}~1members~1{member_address}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/lists/{list_address}/members/{member_address}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"list_address","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"member_address","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/v3/lists/{list_address}/members/{member_address}","href":"mailing-lists/get-lists-list_address-members-member_address","openApiOperationId":"get-lists-list_address-members-member_address","summary":"Get a member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListMemberResponse","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/ListMemberResponse","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/get/responses/200/content/application~1json/examples/Example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/get/responses/429/content/application~1json/examples/Example"]}},"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/get/responses/429/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1lists~1{list_address}~1members~1{member_address}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListMemberResponse","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListMemberResponse","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"429","schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/get/responses/429/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/get/responses/429/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mailing-lists/get-lists-list_address-members-member_address"}],"panels":[]}]},"httpPath":"/v3/lists/{list_address}/members/{member_address}"},{"label":"Update a mailing list member","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/put-lists-list_address-members-member_address","routeSlug":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/put-lists-list_address-members-member_address","metadata":{"seo":{"title":"Update a mailing list member","description":"Updates a mailing list member with the given properties. Existing properties not included in the request will not be changed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-lists-list_address-members-member_address","name":"Update a mailing list member","isWebhook":false,"pointer":"/paths/~1v3~1lists~1{list_address}~1members~1{member_address}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a mailing list member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a mailing list member with the given properties. Existing properties not included in the request will not be changed."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"list_address","in":"path","schemaId":"components/schemas/string","description":"The mailing list's address","required":true},{"name":"member_address","in":"path","schemaId":"components/schemas/string","description":"The member's address","required":true}],"pointer":"/paths/~1v3~1lists~1{list_address}~1members~1{member_address}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_288","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/put/requestBody/content/multipart~1form-data/examples/Example"]}},"schemaId":"schema_288","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/put/requestBody/content/multipart~1form-data/examples/Example"],"pointer":"/paths/~1v3~1lists~1{list_address}~1members~1{member_address}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/lists/{list_address}/members/{member_address}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"list_address","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"member_address","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_288","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/put/requestBody/content/multipart~1form-data/examples/Example"]}},"responseCodes":["200","429"],"pointer":"/v3/lists/{list_address}/members/{member_address}","href":"mailing-lists/put-lists-list_address-members-member_address","openApiOperationId":"put-lists-list_address-members-member_address","summary":"Update a mailing list member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"schema_288","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/put/requestBody/content/multipart~1form-data/examples/Example"],"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_288","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/put/requestBody/content/multipart~1form-data/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_284","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"schema_284","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/put/responses/200/content/application~1json/examples/Example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/put/responses/429/content/application~1json/examples/Example"]}},"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/put/responses/429/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1lists~1{list_address}~1members~1{member_address}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_284","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_284","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"429","schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/put/responses/429/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/put/responses/429/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mailing-lists/put-lists-list_address-members-member_address"}],"panels":[]}]},"httpPath":"/v3/lists/{list_address}/members/{member_address}"},{"label":"Delete a member","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/delete-lists-list_address-members-member_address","routeSlug":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/delete-lists-list_address-members-member_address","metadata":{"seo":{"title":"Delete a member","description":"Deletes a member from a mailing list"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-lists-list_address-members-member_address","name":"Delete a member","isWebhook":false,"pointer":"/paths/~1v3~1lists~1{list_address}~1members~1{member_address}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a member from a mailing list"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"list_address","in":"path","schemaId":"components/schemas/string","description":"The mailing list's address","required":true},{"name":"member_address","in":"path","schemaId":"components/schemas/string","description":"The member's address","required":true}],"pointer":"/paths/~1v3~1lists~1{list_address}~1members~1{member_address}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/lists/{list_address}/members/{member_address}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"list_address","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"member_address","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404","429"],"pointer":"/v3/lists/{list_address}/members/{member_address}","href":"mailing-lists/delete-lists-list_address-members-member_address","openApiOperationId":"delete-lists-list_address-members-member_address","summary":"Delete a member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_289","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"schema_289","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/delete/responses/200/content/application~1json/examples/Example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/delete/responses/404/content/application~1json/examples/Example"]}},"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/delete/responses/404/content/application~1json/examples/Example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/delete/responses/429/content/application~1json/examples/Example"]}},"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/delete/responses/429/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1lists~1{list_address}~1members~1{member_address}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_289","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_289","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/delete/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/delete/responses/404/content/application~1json/examples/Example"]}}},{"code":"429","schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/delete/responses/429/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1{member_address}/delete/responses/429/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mailing-lists/delete-lists-list_address-members-member_address"}],"panels":[]}]},"httpPath":"/v3/lists/{list_address}/members/{member_address}"},{"label":"Update a mailing list","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/put-v3-lists-address","routeSlug":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/put-v3-lists-address","metadata":{"seo":{"title":"Update a mailing list","description":"Update mailing list properties, such as address, description or name"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-v3-lists-address","name":"Update a mailing list","isWebhook":false,"pointer":"/paths/~1v3~1lists~1{list_address}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a mailing list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update mailing list properties, such as address, description or name"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"list_address","in":"path","schemaId":"components/schemas/string","description":"The mailing list's address","required":true}],"pointer":"/paths/~1v3~1lists~1{list_address}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_290","exampleIds":["paths/~1v3~1lists~1{list_address}/put/requestBody/content/multipart~1form-data/examples/Example"]}},"schemaId":"schema_290","exampleIds":["paths/~1v3~1lists~1{list_address}/put/requestBody/content/multipart~1form-data/examples/Example"],"pointer":"/paths/~1v3~1lists~1{list_address}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/lists/{list_address}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"list_address","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_290","exampleIds":["paths/~1v3~1lists~1{list_address}/put/requestBody/content/multipart~1form-data/examples/Example"]}},"responseCodes":["200","404","429"],"pointer":"/v3/lists/{list_address}","href":"mailing-lists/put-v3-lists-address","openApiOperationId":"put-v3-lists-address","summary":"Update a mailing list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"schema_290","exampleIds":["paths/~1v3~1lists~1{list_address}/put/requestBody/content/multipart~1form-data/examples/Example"],"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_290","exampleIds":["paths/~1v3~1lists~1{list_address}/put/requestBody/content/multipart~1form-data/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_291","exampleIds":["paths/~1v3~1lists~1{list_address}/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"schema_291","exampleIds":["paths/~1v3~1lists~1{list_address}/put/responses/200/content/application~1json/examples/Example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}/put/responses/404/content/application~1json/examples/Example"]}},"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}/put/responses/404/content/application~1json/examples/Example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}/put/responses/429/content/application~1json/examples/Example"]}},"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}/put/responses/429/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1lists~1{list_address}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_291","exampleIds":["paths/~1v3~1lists~1{list_address}/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_291","exampleIds":["paths/~1v3~1lists~1{list_address}/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}/put/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}/put/responses/404/content/application~1json/examples/Example"]}}},{"code":"429","schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}/put/responses/429/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}/put/responses/429/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mailing-lists/put-v3-lists-address"}],"panels":[]}]},"httpPath":"/v3/lists/{list_address}"},{"label":"Delete a mailing list","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/delete-v3-lists-address","routeSlug":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/delete-v3-lists-address","metadata":{"seo":{"title":"Delete a mailing list","description":"Deletes a mailing list"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-v3-lists-address","name":"Delete a mailing list","isWebhook":false,"pointer":"/paths/~1v3~1lists~1{list_address}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a mailing list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a mailing list"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"list_address","in":"path","schemaId":"components/schemas/string","description":"The mailing list's address","required":true}],"pointer":"/paths/~1v3~1lists~1{list_address}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/lists/{list_address}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"list_address","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404","429"],"pointer":"/v3/lists/{list_address}","href":"mailing-lists/delete-v3-lists-address","openApiOperationId":"delete-v3-lists-address","summary":"Delete a mailing list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_292","exampleIds":["paths/~1v3~1lists~1{list_address}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"schema_292","exampleIds":["paths/~1v3~1lists~1{list_address}/delete/responses/200/content/application~1json/examples/Example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}/delete/responses/404/content/application~1json/examples/Example"]}},"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}/delete/responses/404/content/application~1json/examples/Example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}/delete/responses/429/content/application~1json/examples/Example"]}},"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}/delete/responses/429/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1lists~1{list_address}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_292","exampleIds":["paths/~1v3~1lists~1{list_address}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_292","exampleIds":["paths/~1v3~1lists~1{list_address}/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}/delete/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}/delete/responses/404/content/application~1json/examples/Example"]}}},{"code":"429","schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}/delete/responses/429/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}/delete/responses/429/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mailing-lists/delete-v3-lists-address"}],"panels":[]}]},"httpPath":"/v3/lists/{list_address}"},{"label":"Get a mailing list by address","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-v3-lists-address","routeSlug":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-v3-lists-address","metadata":{"seo":{"title":"Get a mailing list by address","description":"Returns the matching mailing list for the given address"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-v3-lists-address","name":"Get a mailing list by address","isWebhook":false,"pointer":"/paths/~1v3~1lists~1{list_address}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a mailing list by address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the matching mailing list for the given address"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"list_address","in":"path","schemaId":"components/schemas/string","description":"The mailing list's address","required":true}],"pointer":"/paths/~1v3~1lists~1{list_address}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/lists/{list_address}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"list_address","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404","429"],"pointer":"/v3/lists/{list_address}","href":"mailing-lists/get-v3-lists-address","openApiOperationId":"get-v3-lists-address","summary":"Get a mailing list by address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_279","exampleIds":["paths/~1v3~1lists~1{list_address}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"schema_279","exampleIds":["paths/~1v3~1lists~1{list_address}/get/responses/200/content/application~1json/examples/Example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}/get/responses/404/content/application~1json/examples/Example"]}},"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}/get/responses/404/content/application~1json/examples/Example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}/get/responses/429/content/application~1json/examples/Example"]}},"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}/get/responses/429/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1lists~1{list_address}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_279","exampleIds":["paths/~1v3~1lists~1{list_address}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_279","exampleIds":["paths/~1v3~1lists~1{list_address}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}/get/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}/get/responses/404/content/application~1json/examples/Example"]}}},{"code":"429","schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}/get/responses/429/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}/get/responses/429/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mailing-lists/get-v3-lists-address"}],"panels":[]}]},"httpPath":"/v3/lists/{list_address}"},{"label":"Get mailing lists by page","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-v3-lists-pages","routeSlug":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-v3-lists-pages","metadata":{"seo":{"title":"Get mailing lists by page","description":"Paginate over mailing lists"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-v3-lists-pages","name":"Get mailing lists by page","isWebhook":false,"pointer":"/paths/~1v3~1lists~1pages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get mailing lists by page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Paginate over mailing lists"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_260","description":"Set limit for the list length returned. Defaults to 100."}],"pointer":"/paths/~1v3~1lists~1pages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/lists/pages","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_260"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/v3/lists/pages","href":"mailing-lists/get-v3-lists-pages","openApiOperationId":"get-v3-lists-pages","summary":"Get mailing lists by page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginateMailingListResponse","exampleIds":["paths/~1v3~1lists~1pages/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/PaginateMailingListResponse","exampleIds":["paths/~1v3~1lists~1pages/get/responses/200/content/application~1json/examples/Example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1pages/get/responses/429/content/application~1json/examples/Example"]}},"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1pages/get/responses/429/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1lists~1pages/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginateMailingListResponse","exampleIds":["paths/~1v3~1lists~1pages/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginateMailingListResponse","exampleIds":["paths/~1v3~1lists~1pages/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"429","schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1pages/get/responses/429/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1pages/get/responses/429/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mailing-lists/get-v3-lists-pages"}],"panels":[]}]},"httpPath":"/v3/lists/pages"},{"label":"Get members by page","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-lists-list_address-members-pages","routeSlug":"/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-lists-list_address-members-pages","metadata":{"seo":{"title":"Get members by page","description":"Paginate over list members in a given mailing list in ascending order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-lists-list_address-members-pages","name":"Get members by page","isWebhook":false,"pointer":"/paths/~1v3~1lists~1{list_address}~1members~1pages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get members by page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Paginate over list members in a given mailing list in ascending order"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"list_address","in":"path","schemaId":"components/schemas/string","description":"The mailing list's address","required":true}],"pointer":"/paths/~1v3~1lists~1{list_address}~1members~1pages/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"subscribed","in":"query","schemaId":"schema_261","description":"Filtering list on whether the member is subscribed or not."},{"name":"limit","in":"query","schemaId":"schema_260","description":"Set limit for the list length returned. Defaults to 100."},{"name":"address","in":"query","schemaId":"components/schemas/string","description":"Use as pivot for pagination."},{"name":"page","in":"query","schemaId":"components/schemas/string","description":"Could be either: first, last, next or prev"}],"pointer":"/paths/~1v3~1lists~1{list_address}~1members~1pages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/lists/{list_address}/members/pages","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"list_address","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"subscribed","in":"query","schemaId":"schema_261"},{"name":"limit","in":"query","schemaId":"schema_260"},{"name":"address","in":"query","schemaId":"components/schemas/string"},{"name":"page","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/v3/lists/{list_address}/members/pages","href":"mailing-lists/get-lists-list_address-members-pages","openApiOperationId":"get-lists-list_address-members-pages","summary":"Get members by page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginateListMemberResponse","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1pages/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/PaginateListMemberResponse","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1pages/get/responses/200/content/application~1json/examples/Example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1pages/get/responses/429/content/application~1json/examples/Example"]}},"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1pages/get/responses/429/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1lists~1{list_address}~1members~1pages/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginateListMemberResponse","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1pages/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginateListMemberResponse","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1pages/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"429","schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1pages/get/responses/429/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1v3~1lists~1{list_address}~1members~1pages/get/responses/429/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mailing-lists/get-lists-list_address-members-pages"}],"panels":[]}]},"httpPath":"/v3/lists/{list_address}/members/pages"}],"content":{"contentType":"group","meta":{"name":"Mailing Lists"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mailing Lists","showPageActions":true},{"nodeType":"markdoc","content":"Programatically create mailing lists."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/lists","summary":"Create a mailing list","prefix":{"name":"post","color":"post"},"badges":[],"link":"/mailing-lists/post-v3-lists","deprecated":false},{"title":"/v3/lists","summary":"Get mailing lists","prefix":{"name":"get","color":"get"},"badges":[],"link":"/mailing-lists/get-v3-lists","deprecated":false},{"title":"/v3/lists/{list_address}/members","summary":"Get mailing lists members","prefix":{"name":"get","color":"get"},"badges":[],"link":"/mailing-lists/get-lists-string:list_address-members","deprecated":false},{"title":"/v3/lists/{list_address}/members","summary":"Create a mailing list member","prefix":{"name":"post","color":"post"},"badges":[],"link":"/mailing-lists/post-lists-string:list_address-members","deprecated":false},{"title":"/v3/lists/{list_address}/members.json","summary":"Bulk upload members to a mailing list (JSON)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/mailing-lists/post-lists-list_address-members.json","deprecated":false},{"title":"/v3/lists/{list_address}/members.csv","summary":"Bulk upload members to a mailing list (CSV)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/mailing-lists/post-lists-list_address-members.csv","deprecated":false},{"title":"/v3/lists/{list_address}/members/{member_address}","summary":"Get a member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/mailing-lists/get-lists-list_address-members-member_address","deprecated":false},{"title":"/v3/lists/{list_address}/members/{member_address}","summary":"Update a mailing list member","prefix":{"name":"put","color":"put"},"badges":[],"link":"/mailing-lists/put-lists-list_address-members-member_address","deprecated":false},{"title":"/v3/lists/{list_address}/members/{member_address}","summary":"Delete a member","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/mailing-lists/delete-lists-list_address-members-member_address","deprecated":false},{"title":"/v3/lists/{list_address}","summary":"Update a mailing list","prefix":{"name":"put","color":"put"},"badges":[],"link":"/mailing-lists/put-v3-lists-address","deprecated":false},{"title":"/v3/lists/{list_address}","summary":"Delete a mailing list","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/mailing-lists/delete-v3-lists-address","deprecated":false},{"title":"/v3/lists/{list_address}","summary":"Get a mailing list by address","prefix":{"name":"get","color":"get"},"badges":[],"link":"/mailing-lists/get-v3-lists-address","deprecated":false},{"title":"/v3/lists/pages","summary":"Get mailing lists by page","prefix":{"name":"get","color":"get"},"badges":[],"link":"/mailing-lists/get-v3-lists-pages","deprecated":false},{"title":"/v3/lists/{list_address}/members/pages","summary":"Get members by page","prefix":{"name":"get","color":"get"},"badges":[],"link":"/mailing-lists/get-lists-list_address-members-pages","deprecated":false}]}]}]}]}},{"type":"separator","label":"Templates","content":null},{"type":"group","label":"Account Templates","link":"/docs/mailgun/api-reference/send/mailgun/account-templates","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-templates","items":[{"label":"Get account-level templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-templates/get-v4-templates","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-templates/get-v4-templates","metadata":{"seo":{"title":"Get account-level templates","description":"Returns a list of account-level templates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v4-templates","name":"Get account-level templates","isWebhook":false,"pointer":"/paths/~1v4~1templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get account-level templates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of account-level templates."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_293","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the page to retrieve. Value can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_260","description":"Number of templates to retrieve. Default and max limit is 100."},{"name":"p","in":"query","schemaId":"components/schemas/string","description":"Pivot used to retrieve the next page of templates."}],"pointer":"/paths/~1v4~1templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/templates","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_293"},{"name":"limit","in":"query","schemaId":"schema_260"},{"name":"p","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/v4/templates","href":"account-templates/get-v4-templates","openApiOperationId":"GET-v4-templates","summary":"Get account-level templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getPageResponse","exampleIds":["paths/~1v4~1templates/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getPageResponse","exampleIds":["paths/~1v4~1templates/get/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v4~1templates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getPageResponse","exampleIds":["paths/~1v4~1templates/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getPageResponse","exampleIds":["paths/~1v4~1templates/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-templates/get-v4-templates"}],"panels":[]}]},"httpPath":"/v4/templates"},{"label":"Create an account-level template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-templates/post-v4-templates","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-templates/post-v4-templates","metadata":{"seo":{"title":"Create an account-level template","description":"Store a new account-level template that is available across all domains for the account. Include the template name, description and (optionally) the template content. If the template content is provided, a new version is automatically created and becomes the active version."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v4-templates","name":"Create an account-level template","isWebhook":false,"pointer":"/paths/~1v4~1templates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an account-level template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Store a new account-level template that is available across all domains for the account. Include the template name, description and (optionally) the template content. If the template content is provided, a new version is automatically created and becomes the active version."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v4-templates-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/POST-v4-templates-multipart-form-data-RequestBody","pointer":"/paths/~1v4~1templates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/templates","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/POST-v4-templates-multipart-form-data-RequestBody"}},"responseCodes":["200","400","401","409","500"],"pointer":"/v4/templates","href":"account-templates/post-v4-templates","openApiOperationId":"POST-v4-templates","summary":"Create an account-level template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/POST-v4-templates-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v4-templates-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-createTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-createTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"409","description":"A 409 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v4~1templates/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-createTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-createTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"409","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-templates/post-v4-templates"}],"panels":[]}]},"httpPath":"/v4/templates"},{"label":"Delete all account-level templates","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-templates/delete-v4-templates","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-templates/delete-v4-templates","metadata":{"seo":{"title":"Delete all account-level templates","description":"Delete all account-level templates and their versions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v4-templates","name":"Delete all account-level templates","isWebhook":false,"pointer":"/paths/~1v4~1templates/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete all account-level templates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete all account-level templates and their versions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v4/templates","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/v4/templates","href":"account-templates/delete-v4-templates","openApiOperationId":"DELETE-v4-templates","summary":"Delete all account-level templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1templates/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1templates/delete/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v4~1templates/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1templates/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v4~1templates/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-templates/delete-v4-templates"}],"panels":[]}]},"httpPath":"/v4/templates"},{"label":"Get all account-level template versions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-templates/get-v4-templates--template-name--versions","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-templates/get-v4-templates--template-name--versions","metadata":{"seo":{"title":"Get all account-level template versions","description":"Returns a paginated list of versions for an account-level template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v4-templates--template-name--versions","name":"Get all account-level template versions","isWebhook":false,"pointer":"/paths/~1v4~1templates~1{template_name}~1versions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all account-level template versions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of versions for an account-level template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"template_name","in":"path","schemaId":"components/schemas/string","description":"Template name to fetch the versions for.","required":true}],"pointer":"/paths/~1v4~1templates~1{template_name}~1versions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_293","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the page to retrieve. Value can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_260","description":"Number of versions to retrieve. Default and max limit is 100."},{"name":"p","in":"query","schemaId":"components/schemas/string","description":"Pivot used to retrieve the next page of versions."}],"pointer":"/paths/~1v4~1templates~1{template_name}~1versions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/templates/{template_name}/versions","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"template_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"page","in":"query","schemaId":"schema_293"},{"name":"limit","in":"query","schemaId":"schema_260"},{"name":"p","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v4/templates/{template_name}/versions","href":"account-templates/get-v4-templates--template-name--versions","openApiOperationId":"GET-v4-templates--template-name--versions","summary":"Get all account-level template versions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getVersionsPageResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1versions/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getVersionsPageResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1versions/get/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v4~1templates~1{template_name}~1versions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getVersionsPageResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1versions/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getVersionsPageResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1versions/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-templates/get-v4-templates--template-name--versions"}],"panels":[]}]},"httpPath":"/v4/templates/{template_name}/versions"},{"label":"Create an account-level template version","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-templates/post-v4-templates--template-name--versions","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-templates/post-v4-templates--template-name--versions","metadata":{"seo":{"title":"Create an account-level template version","description":"Adds a new version to an account-level template. If the template doesn't contain any other versions, the first version becomes active. A template can store up to 40 versions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v4-templates--template-name--versions","name":"Create an account-level template version","isWebhook":false,"pointer":"/paths/~1v4~1templates~1{template_name}~1versions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an account-level template version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a new version to an account-level template. If the template doesn't contain any other versions, the first version becomes active. A template can store up to 40 versions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"template_name","in":"path","schemaId":"components/schemas/string","description":"Template name to create the new version for.","required":true}],"pointer":"/paths/~1v4~1templates~1{template_name}~1versions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v4-templates-template_name-versions-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/POST-v4-templates-template_name-versions-multipart-form-data-RequestBody","pointer":"/paths/~1v4~1templates~1{template_name}~1versions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/templates/{template_name}/versions","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"template_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/POST-v4-templates-template_name-versions-multipart-form-data-RequestBody"}},"responseCodes":["200","400","401","404","500"],"pointer":"/v4/templates/{template_name}/versions","href":"account-templates/post-v4-templates--template-name--versions","openApiOperationId":"POST-v4-templates--template-name--versions","summary":"Create an account-level template version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/POST-v4-templates-template_name-versions-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v4-templates-template_name-versions-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-createTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1versions/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-createTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1versions/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v4~1templates~1{template_name}~1versions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-createTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1versions/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-createTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1versions/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-templates/post-v4-templates--template-name--versions"}],"panels":[]}]},"httpPath":"/v4/templates/{template_name}/versions"},{"label":"Get an account-level template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-templates/get-v4-templates--template-name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-templates/get-v4-templates--template-name-","metadata":{"seo":{"title":"Get an account-level template","description":"Returns metadata information about the stored account-level template. If the active flag is provided, the content of the active version of the template is returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v4-templates--template-name-","name":"Get an account-level template","isWebhook":false,"pointer":"/paths/~1v4~1templates~1{template_name}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an account-level template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns metadata information about the stored account-level template. If the active flag is provided, the content of the active version of the template is returned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"template_name","in":"path","schemaId":"components/schemas/string","description":"Template name to fetch.","required":true}],"pointer":"/paths/~1v4~1templates~1{template_name}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"active","in":"query","schemaId":"components/schemas/string","description":"If this flag is set to yes the active version of the template is included in the response."}],"pointer":"/paths/~1v4~1templates~1{template_name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/templates/{template_name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"template_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"active","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v4/templates/{template_name}","href":"account-templates/get-v4-templates--template-name-","openApiOperationId":"GET-v4-templates--template-name-","summary":"Get an account-level template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}/get/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v4~1templates~1{template_name}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-templates/get-v4-templates--template-name-"}],"panels":[]}]},"httpPath":"/v4/templates/{template_name}"},{"label":"Update an account-level template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-templates/put-v4-templates--template-name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-templates/put-v4-templates--template-name-","metadata":{"seo":{"title":"Update an account-level template","description":"Update the description of an account-level template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v4-templates--template-name-","name":"Update an account-level template","isWebhook":false,"pointer":"/paths/~1v4~1templates~1{template_name}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an account-level template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the description of an account-level template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"template_name","in":"path","schemaId":"components/schemas/string","description":"The template name.","required":true}],"pointer":"/paths/~1v4~1templates~1{template_name}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domain_name-templates-template_name-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/PUT-v3-domain_name-templates-template_name-multipart-form-data-RequestBody","pointer":"/paths/~1v4~1templates~1{template_name}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v4/templates/{template_name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"template_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domain_name-templates-template_name-multipart-form-data-RequestBody"}},"responseCodes":["200","401","404","500"],"pointer":"/v4/templates/{template_name}","href":"account-templates/put-v4-templates--template-name-","openApiOperationId":"PUT-v4-templates--template-name-","summary":"Update an account-level template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/PUT-v3-domain_name-templates-template_name-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domain_name-templates-template_name-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}/put/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v4~1templates~1{template_name}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-templates/put-v4-templates--template-name-"}],"panels":[]}]},"httpPath":"/v4/templates/{template_name}"},{"label":"Delete an account-level template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-templates/delete-v4-templates--template-name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-templates/delete-v4-templates--template-name-","metadata":{"seo":{"title":"Delete an account-level template","description":"Delete the account-level template specified in the url NOTE: This method deletes all versions of the specified template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v4-templates--template-name-","name":"Delete an account-level template","isWebhook":false,"pointer":"/paths/~1v4~1templates~1{template_name}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an account-level template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete the account-level template specified in the url NOTE: This method deletes all versions of the specified template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"template_name","in":"path","schemaId":"components/schemas/string","description":"Template name to be deleted.","required":true}],"pointer":"/paths/~1v4~1templates~1{template_name}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v4/templates/{template_name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"template_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v4/templates/{template_name}","href":"account-templates/delete-v4-templates--template-name-","openApiOperationId":"DELETE-v4-templates--template-name-","summary":"Delete an account-level template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}/delete/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v4~1templates~1{template_name}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-templates/delete-v4-templates--template-name-"}],"panels":[]}]},"httpPath":"/v4/templates/{template_name}"},{"label":"Get an account-level template version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-templates/get-v4-templates--template-name--versions--version-name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-templates/get-v4-templates--template-name--versions--version-name-","metadata":{"seo":{"title":"Get an account-level template version","description":"Retrieve the information and content of the specified version of an account-level template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v4-templates--template-name--versions--version-name-","name":"Get an account-level template version","isWebhook":false,"pointer":"/paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an account-level template version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the information and content of the specified version of an account-level template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"template_name","in":"path","schemaId":"components/schemas/string","description":"Template name the version is for.","required":true},{"name":"version_name","in":"path","schemaId":"components/schemas/string","description":"Tag of the version of the template to fetch.","required":true}],"pointer":"/paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/templates/{template_name}/versions/{version_name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"template_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"version_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v4/templates/{template_name}/versions/{version_name}","href":"account-templates/get-v4-templates--template-name--versions--version-name-","openApiOperationId":"GET-v4-templates--template-name--versions--version-name-","summary":"Get an account-level template version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/get/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-templates/get-v4-templates--template-name--versions--version-name-"}],"panels":[]}]},"httpPath":"/v4/templates/{template_name}/versions/{version_name}"},{"label":"Update an account-level template version","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-templates/put-v4-templates--template-name--versions--version-name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-templates/put-v4-templates--template-name--versions--version-name-","metadata":{"seo":{"title":"Update an account-level template version","description":"Update information or content of the specific version of an account-level template. Existing fields not included in the request will not be changed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v4-templates--template-name--versions--version-name-","name":"Update an account-level template version","isWebhook":false,"pointer":"/paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an account-level template version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update information or content of the specific version of an account-level template. Existing fields not included in the request will not be changed."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"template_name","in":"path","schemaId":"components/schemas/string","description":"Template name the version is stored under.","required":true},{"name":"version_name","in":"path","schemaId":"components/schemas/string","description":"Tag of the version of the template to be updated.","required":true}],"pointer":"/paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v4-templates-template_name-versions-version_name-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/PUT-v4-templates-template_name-versions-version_name-multipart-form-data-RequestBody","pointer":"/paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v4/templates/{template_name}/versions/{version_name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"template_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"version_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v4-templates-template_name-versions-version_name-multipart-form-data-RequestBody"}},"responseCodes":["200","400","401","404","500"],"pointer":"/v4/templates/{template_name}/versions/{version_name}","href":"account-templates/put-v4-templates--template-name--versions--version-name-","openApiOperationId":"PUT-v4-templates--template-name--versions--version-name-","summary":"Update an account-level template version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/PUT-v4-templates-template_name-versions-version_name-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v4-templates-template_name-versions-version_name-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/put/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-templates/put-v4-templates--template-name--versions--version-name-"}],"panels":[]}]},"httpPath":"/v4/templates/{template_name}/versions/{version_name}"},{"label":"Delete an account-level template version","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-templates/delete-v4-templates--template-name--versions--version-name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-templates/delete-v4-templates--template-name--versions--version-name-","metadata":{"seo":{"title":"Delete an account-level template version","description":"Delete a specific version of an account-level template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v4-templates--template-name--versions--version-name-","name":"Delete an account-level template version","isWebhook":false,"pointer":"/paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an account-level template version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a specific version of an account-level template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"template_name","in":"path","schemaId":"components/schemas/string","description":"Template name the version is stored under.","required":true},{"name":"version_name","in":"path","schemaId":"components/schemas/string","description":"Tag of the version of the template to be deleted.","required":true}],"pointer":"/paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v4/templates/{template_name}/versions/{version_name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"template_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"version_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v4/templates/{template_name}/versions/{version_name}","href":"account-templates/delete-v4-templates--template-name--versions--version-name-","openApiOperationId":"DELETE-v4-templates--template-name--versions--version-name-","summary":"Delete an account-level template version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/delete/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-templates/delete-v4-templates--template-name--versions--version-name-"}],"panels":[]}]},"httpPath":"/v4/templates/{template_name}/versions/{version_name}"},{"label":"Copy a template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-templates/put-v4-templates--template-name--copy","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-templates/put-v4-templates--template-name--copy","metadata":{"seo":{"title":"Copy a template","description":"Copies an existing template into new templates with the provided names and account IDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v4-templates--template-name--copy","name":"Copy a template","isWebhook":false,"pointer":"/paths/~1v4~1templates~1{template_name}~1copy/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Copy a template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Copies an existing template into new templates with the provided names and account IDs."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"template_name","in":"path","schemaId":"components/schemas/string","description":"The name of the source template","required":true}],"pointer":"/paths/~1v4~1templates~1{template_name}~1copy/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyParams","exampleIds":["paths/~1v4~1templates~1{template_name}~1copy/put/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyParams","exampleIds":["paths/~1v4~1templates~1{template_name}~1copy/put/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v4~1templates~1{template_name}~1copy/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v4/templates/{template_name}/copy","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"template_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyParams","exampleIds":["paths/~1v4~1templates~1{template_name}~1copy/put/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["200","400","401","404","500"],"pointer":"/v4/templates/{template_name}/copy","href":"account-templates/put-v4-templates--template-name--copy","openApiOperationId":"PUT-v4-templates--template-name--copy","summary":"Copy a template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyParams","exampleIds":["paths/~1v4~1templates~1{template_name}~1copy/put/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyParams","exampleIds":["paths/~1v4~1templates~1{template_name}~1copy/put/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1copy/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1copy/put/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v4~1templates~1{template_name}~1copy/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1copy/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1copy/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-templates/put-v4-templates--template-name--copy"}],"panels":[]}]},"httpPath":"/v4/templates/{template_name}/copy"},{"label":"Copy an account-level template version","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-templates/put-v4-templates--template-name--versions--version-name--copy--new-version-name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-templates/put-v4-templates--template-name--versions--version-name--copy--new-version-name-","metadata":{"seo":{"title":"Copy an account-level template version","description":"Copies an existing version of an account-level template into a new version with the provided name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v4-templates--template-name--versions--version-name--copy--new-version-name-","name":"Copy an account-level template version","isWebhook":false,"pointer":"/paths/~1v4~1templates~1{template_name}~1versions~1{version_name}~1copy~1{new_version_name}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Copy an account-level template version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Copies an existing version of an account-level template into a new version with the provided name."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"template_name","in":"path","schemaId":"components/schemas/string","description":"Template name the version is stored under.","required":true},{"name":"version_name","in":"path","schemaId":"components/schemas/string","description":"Tag of the version to copy.","required":true},{"name":"new_version_name","in":"path","schemaId":"components/schemas/string","description":"The name for the new version. If the version name already exists, the copy will fail.","required":true}],"pointer":"/paths/~1v4~1templates~1{template_name}~1versions~1{version_name}~1copy~1{new_version_name}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"comment","in":"query","schemaId":"components/schemas/string","description":"Comment to be used for the new version."}],"pointer":"/paths/~1v4~1templates~1{template_name}~1versions~1{version_name}~1copy~1{new_version_name}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v4/templates/{template_name}/versions/{version_name}/copy/{new_version_name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"template_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"version_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"new_version_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"comment","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v4/templates/{template_name}/versions/{version_name}/copy/{new_version_name}","href":"account-templates/put-v4-templates--template-name--versions--version-name--copy--new-version-name-","openApiOperationId":"PUT-v4-templates--template-name--versions--version-name--copy--new-version-name-","summary":"Copy an account-level template version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-versionCopyResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1versions~1{version_name}~1copy~1{new_version_name}/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-versionCopyResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1versions~1{version_name}~1copy~1{new_version_name}/put/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v4~1templates~1{template_name}~1versions~1{version_name}~1copy~1{new_version_name}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-versionCopyResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1versions~1{version_name}~1copy~1{new_version_name}/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-versionCopyResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1versions~1{version_name}~1copy~1{new_version_name}/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-templates/put-v4-templates--template-name--versions--version-name--copy--new-version-name-"}],"panels":[]}]},"httpPath":"/v4/templates/{template_name}/versions/{version_name}/copy/{new_version_name}"},{"label":"Rename a template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-templates/put-v4-templates--template-name--rename--new-template-name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-templates/put-v4-templates--template-name--rename--new-template-name-","metadata":{"seo":{"title":"Rename a template","description":"Renames the specified account level template"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v4-templates--template-name--rename--new-template-name-","name":"Rename a template","isWebhook":false,"pointer":"/paths/~1v4~1templates~1{template_name}~1rename~1{new_template_name}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rename a template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Renames the specified account level template"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"template_name","in":"path","schemaId":"components/schemas/string","description":"The current name of the template.","required":true},{"name":"new_template_name","in":"path","schemaId":"components/schemas/string","description":"The name for the new template.","required":true}],"pointer":"/paths/~1v4~1templates~1{template_name}~1rename~1{new_template_name}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v4/templates/{template_name}/rename/{new_template_name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"template_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"new_template_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v4/templates/{template_name}/rename/{new_template_name}","href":"account-templates/put-v4-templates--template-name--rename--new-template-name-","openApiOperationId":"PUT-v4-templates--template-name--rename--new-template-name-","summary":"Rename a template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1rename~1{new_template_name}/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1rename~1{new_template_name}/put/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v4~1templates~1{template_name}~1rename~1{new_template_name}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1rename~1{new_template_name}/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v4~1templates~1{template_name}~1rename~1{new_template_name}/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-templates/put-v4-templates--template-name--rename--new-template-name-"}],"panels":[]}]},"httpPath":"/v4/templates/{template_name}/rename/{new_template_name}"}],"content":{"contentType":"group","meta":{"name":"Account Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Templates","showPageActions":true},{"nodeType":"markdoc","content":"This API allows you to store predefined templates at the account level and use them to send messages using the Sending API."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/templates","summary":"Get account-level templates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-templates/get-v4-templates","deprecated":false},{"title":"/v4/templates","summary":"Create an account-level template","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-templates/post-v4-templates","deprecated":false},{"title":"/v4/templates","summary":"Delete all account-level templates","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/account-templates/delete-v4-templates","deprecated":false},{"title":"/v4/templates/{template_name}/versions","summary":"Get all account-level template versions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-templates/get-v4-templates--template-name--versions","deprecated":false},{"title":"/v4/templates/{template_name}/versions","summary":"Create an account-level template version","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-templates/post-v4-templates--template-name--versions","deprecated":false},{"title":"/v4/templates/{template_name}","summary":"Get an account-level template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-templates/get-v4-templates--template-name-","deprecated":false},{"title":"/v4/templates/{template_name}","summary":"Update an account-level template","prefix":{"name":"put","color":"put"},"badges":[],"link":"/account-templates/put-v4-templates--template-name-","deprecated":false},{"title":"/v4/templates/{template_name}","summary":"Delete an account-level template","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/account-templates/delete-v4-templates--template-name-","deprecated":false},{"title":"/v4/templates/{template_name}/versions/{version_name}","summary":"Get an account-level template version","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-templates/get-v4-templates--template-name--versions--version-name-","deprecated":false},{"title":"/v4/templates/{template_name}/versions/{version_name}","summary":"Update an account-level template version","prefix":{"name":"put","color":"put"},"badges":[],"link":"/account-templates/put-v4-templates--template-name--versions--version-name-","deprecated":false},{"title":"/v4/templates/{template_name}/versions/{version_name}","summary":"Delete an account-level template version","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/account-templates/delete-v4-templates--template-name--versions--version-name-","deprecated":false},{"title":"/v4/templates/{template_name}/copy","summary":"Copy a template","prefix":{"name":"put","color":"put"},"badges":[],"link":"/account-templates/put-v4-templates--template-name--copy","deprecated":false},{"title":"/v4/templates/{template_name}/versions/{version_name}/copy/{new_version_name}","summary":"Copy an account-level template version","prefix":{"name":"put","color":"put"},"badges":[],"link":"/account-templates/put-v4-templates--template-name--versions--version-name--copy--new-version-name-","deprecated":false},{"title":"/v4/templates/{template_name}/rename/{new_template_name}","summary":"Rename a template","prefix":{"name":"put","color":"put"},"badges":[],"link":"/account-templates/put-v4-templates--template-name--rename--new-template-name-","deprecated":false}]}]}]}]}},{"type":"group","label":"Domain Templates","link":"/docs/mailgun/api-reference/send/mailgun/domain-templates","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-templates","items":[{"label":"Get templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-templates/get-v3--domain-name--templates","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-templates/get-v3--domain-name--templates","metadata":{"seo":{"title":"Get templates","description":"Returns a list of templates for the domain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3--domain-name--templates","name":"Get templates","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get templates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of templates for the domain."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain name to fetch the templates for.","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1templates/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_293","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the page to retrieve. Value can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_260","description":"Number of templates to retrieve. Default and max limit is 100."},{"name":"p","in":"query","schemaId":"components/schemas/string","description":"Pivot used to retrieve the next page of templates."}],"pointer":"/paths/~1v3~1{domain_name}~1templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/{domain_name}/templates","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"page","in":"query","schemaId":"schema_293"},{"name":"limit","in":"query","schemaId":"schema_260"},{"name":"p","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/v3/{domain_name}/templates","href":"domain-templates/get-v3--domain-name--templates","openApiOperationId":"GET-v3--domain-name--templates","summary":"Get templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getPageResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getPageResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates/get/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1{domain_name}~1templates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getPageResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getPageResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-templates/get-v3--domain-name--templates"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/templates"},{"label":"Create a template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-templates/post-v3--domain-name--templates","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-templates/post-v3--domain-name--templates","metadata":{"seo":{"title":"Create a template","description":"Store a new template, including its name, description and (optionally) the template content. If the template content is provided, a new version is automatically created and becomes the active version."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3--domain-name--templates","name":"Create a template","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1templates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Store a new template, including its name, description and (optionally) the template content. If the template content is provided, a new version is automatically created and becomes the active version."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain name the template is associated with.","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1templates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domain_name-templates-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/POST-v3-domain_name-templates-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1{domain_name}~1templates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/{domain_name}/templates","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domain_name-templates-multipart-form-data-RequestBody"}},"responseCodes":["200","400","401","409","500"],"pointer":"/v3/{domain_name}/templates","href":"domain-templates/post-v3--domain-name--templates","openApiOperationId":"POST-v3--domain-name--templates","summary":"Create a template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/POST-v3-domain_name-templates-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domain_name-templates-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-createTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-createTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"409","description":"A 409 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1{domain_name}~1templates/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-createTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-createTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"409","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-templates/post-v3--domain-name--templates"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/templates"},{"label":"Delete all templates","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-templates/delete-v3--domain-name--templates","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-templates/delete-v3--domain-name--templates","metadata":{"seo":{"title":"Delete all templates","description":"Delete all templates and their versions for the domain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3--domain-name--templates","name":"Delete all templates","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1templates/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete all templates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete all templates and their versions for the domain."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain name the template is associated with.","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1templates/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/{domain_name}/templates","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/v3/{domain_name}/templates","href":"domain-templates/delete-v3--domain-name--templates","openApiOperationId":"DELETE-v3--domain-name--templates","summary":"Delete all templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates/delete/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1{domain_name}~1templates/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-templates/delete-v3--domain-name--templates"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/templates"},{"label":"Get all template versions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-templates/get-v3--domain-name--templates--template-name--versions","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-templates/get-v3--domain-name--templates--template-name--versions","metadata":{"seo":{"title":"Get all template versions","description":"Returns a paginated list of template versions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3--domain-name--templates--template-name--versions","name":"Get all template versions","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all template versions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of template versions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain name to fetch the templates for.","required":true},{"name":"template_name","in":"path","schemaId":"components/schemas/string","description":"Template name to fetch the versions for.","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_293","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the page to retrieve. Value can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_260","description":"Number of templates to retrieve. Default and max limit is 100."},{"name":"p","in":"query","schemaId":"components/schemas/string","description":"Pivot used to retrieve the next page of templates."}],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/{domain_name}/templates/{template_name}/versions","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"template_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"page","in":"query","schemaId":"schema_293"},{"name":"limit","in":"query","schemaId":"schema_260"},{"name":"p","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v3/{domain_name}/templates/{template_name}/versions","href":"domain-templates/get-v3--domain-name--templates--template-name--versions","openApiOperationId":"GET-v3--domain-name--templates--template-name--versions","summary":"Get all template versions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getVersionsPageResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getVersionsPageResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions/get/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getVersionsPageResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getVersionsPageResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-templates/get-v3--domain-name--templates--template-name--versions"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/templates/{template_name}/versions"},{"label":"Create a template version","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-templates/post-v3--domain-name--templates--template-name--versions","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-templates/post-v3--domain-name--templates--template-name--versions","metadata":{"seo":{"title":"Create a template version","description":"Adds a new template version. If the template doesn’t contain any other versions, the first version becomes active. A template can store up to 40 versions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3--domain-name--templates--template-name--versions","name":"Create a template version","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a template version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a new template version. If the template doesn’t contain any other versions, the first version becomes active. A template can store up to 40 versions."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain name the template is associated with.","required":true},{"name":"template_name","in":"path","schemaId":"components/schemas/string","description":"Template name to create the new version for.","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domain_name-templates-template_name-versions-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/POST-v3-domain_name-templates-template_name-versions-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/{domain_name}/templates/{template_name}/versions","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"template_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domain_name-templates-template_name-versions-multipart-form-data-RequestBody"}},"responseCodes":["200","400","401","404","409","500"],"pointer":"/v3/{domain_name}/templates/{template_name}/versions","href":"domain-templates/post-v3--domain-name--templates--template-name--versions","openApiOperationId":"POST-v3--domain-name--templates--template-name--versions","summary":"Create a template version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/POST-v3-domain_name-templates-template_name-versions-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domain_name-templates-template_name-versions-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-createTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-createTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"409","description":"A 409 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-createTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-createTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"409","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-templates/post-v3--domain-name--templates--template-name--versions"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/templates/{template_name}/versions"},{"label":"Get template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-templates/get-v3--domain-name--templates--template-name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-templates/get-v3--domain-name--templates--template-name-","metadata":{"seo":{"title":"Get template","description":"Returns metadata information about the stored template specified in the url. If the active flag is provided, the content of the active version of the template is returned. If the version_name flag is provided, version information will be included as well. By default: the version field is not provided. To see available versions other than the active version, use the /versions API instead"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3--domain-name--templates--template-name-","name":"Get template","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns metadata information about the stored template specified in the url. If the active flag is provided, the content of the active version of the template is returned. If the version_name flag is provided, version information will be included as well. By default: the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not provided. To see available versions other than the active version, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/versions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API instead"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain name the template is stored under.","required":true},{"name":"template_name","in":"path","schemaId":"components/schemas/string","description":"Template name to fetch.","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"active","in":"query","schemaId":"components/schemas/string","description":"If this flag is set to yes the active version of the template is included in the response."}],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/{domain_name}/templates/{template_name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"template_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"active","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v3/{domain_name}/templates/{template_name}","href":"domain-templates/get-v3--domain-name--templates--template-name-","openApiOperationId":"GET-v3--domain-name--templates--template-name-","summary":"Get template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}/get/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-templates/get-v3--domain-name--templates--template-name-"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/templates/{template_name}"},{"label":"Update template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-templates/put-v3--domain-name--templates--template-name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-templates/put-v3--domain-name--templates--template-name-","metadata":{"seo":{"title":"Update template","description":"Update the description of a template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v3--domain-name--templates--template-name-","name":"Update template","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the description of a template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain name the template is associated with.","required":true},{"name":"template_name","in":"path","schemaId":"components/schemas/string","description":"The template name.","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domain_name-templates-template_name-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/PUT-v3-domain_name-templates-template_name-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/{domain_name}/templates/{template_name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"template_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domain_name-templates-template_name-multipart-form-data-RequestBody"}},"responseCodes":["200","401","404","500"],"pointer":"/v3/{domain_name}/templates/{template_name}","href":"domain-templates/put-v3--domain-name--templates--template-name-","openApiOperationId":"PUT-v3--domain-name--templates--template-name-","summary":"Update template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/PUT-v3-domain_name-templates-template_name-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domain_name-templates-template_name-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}/put/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-templates/put-v3--domain-name--templates--template-name-"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/templates/{template_name}"},{"label":"Delete a template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-templates/delete-v3--domain-name--templates--template-name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-templates/delete-v3--domain-name--templates--template-name-","metadata":{"seo":{"title":"Delete a template","description":"Delete the template specified in the url. NOTE: This method deletes all versions of the specified template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3--domain-name--templates--template-name-","name":"Delete a template","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete the template specified in the url. NOTE: This method deletes all versions of the specified template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain name the template is associated with.","required":true},{"name":"template_name","in":"path","schemaId":"components/schemas/string","description":"Template name to be deleted.","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/{domain_name}/templates/{template_name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"template_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v3/{domain_name}/templates/{template_name}","href":"domain-templates/delete-v3--domain-name--templates--template-name-","openApiOperationId":"DELETE-v3--domain-name--templates--template-name-","summary":"Delete a template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}/delete/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-templates/delete-v3--domain-name--templates--template-name-"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/templates/{template_name}"},{"label":"Get a version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-templates/get-v3--domain-name--templates--template-name--versions--version-name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-templates/get-v3--domain-name--templates--template-name--versions--version-name-","metadata":{"seo":{"title":"Get a version","description":"Retrieve the information and content of the specified version of a template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3--domain-name--templates--template-name--versions--version-name-","name":"Get a version","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the information and content of the specified version of a template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain name the template is stored under.","required":true},{"name":"template_name","in":"path","schemaId":"components/schemas/string","description":"Template name the version is for.","required":true},{"name":"version_name","in":"path","schemaId":"components/schemas/string","description":"Tag of the version of the template to fetch.","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/{domain_name}/templates/{template_name}/versions/{version_name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"template_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"version_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v3/{domain_name}/templates/{template_name}/versions/{version_name}","href":"domain-templates/get-v3--domain-name--templates--template-name--versions--version-name-","openApiOperationId":"GET-v3--domain-name--templates--template-name--versions--version-name-","summary":"Get a version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/get/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-getTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-templates/get-v3--domain-name--templates--template-name--versions--version-name-"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/templates/{template_name}/versions/{version_name}"},{"label":"Update a version","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-templates/put-v3--domain-name--templates--template-name--versions--version-name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-templates/put-v3--domain-name--templates--template-name--versions--version-name-","metadata":{"seo":{"title":"Update a version","description":"Update information or content of the specific template version. Existing fields not included in the request will not be changed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v3--domain-name--templates--template-name--versions--version-name-","name":"Update a version","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update information or content of the specific template version. Existing fields not included in the request will not be changed"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain name the template is associated with.","required":true},{"name":"template_name","in":"path","schemaId":"components/schemas/string","description":"Template name the version is stored under.","required":true},{"name":"version_name","in":"path","schemaId":"components/schemas/string","description":"Tag of the version of the template to be updated","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domain_name-templates-template_name-versions-version_name-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/PUT-v3-domain_name-templates-template_name-versions-version_name-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/{domain_name}/templates/{template_name}/versions/{version_name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"template_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"version_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domain_name-templates-template_name-versions-version_name-multipart-form-data-RequestBody"}},"responseCodes":["200","401","404","500"],"pointer":"/v3/{domain_name}/templates/{template_name}/versions/{version_name}","href":"domain-templates/put-v3--domain-name--templates--template-name--versions--version-name-","openApiOperationId":"PUT-v3--domain-name--templates--template-name--versions--version-name-","summary":"Update a version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/PUT-v3-domain_name-templates-template_name-versions-version_name-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domain_name-templates-template_name-versions-version_name-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/put/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-templates/put-v3--domain-name--templates--template-name--versions--version-name-"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/templates/{template_name}/versions/{version_name}"},{"label":"Delete a version","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-templates/delete-v3--domain-name--templates--template-name--versions--version-name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-templates/delete-v3--domain-name--templates--template-name--versions--version-name-","metadata":{"seo":{"title":"Delete a version","description":"Delete a specific template version."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3--domain-name--templates--template-name--versions--version-name-","name":"Delete a version","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a specific template version."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain name the template is associated with.","required":true},{"name":"template_name","in":"path","schemaId":"components/schemas/string","description":"Template name the version is stored under.","required":true},{"name":"version_name","in":"path","schemaId":"components/schemas/string","description":"Tag of the version of the template to be deleted.","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/{domain_name}/templates/{template_name}/versions/{version_name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"template_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"version_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v3/{domain_name}/templates/{template_name}/versions/{version_name}","href":"domain-templates/delete-v3--domain-name--templates--template-name--versions--version-name-","openApiOperationId":"DELETE-v3--domain-name--templates--template-name--versions--version-name-","summary":"Delete a version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/delete/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-templates/delete-v3--domain-name--templates--template-name--versions--version-name-"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/templates/{template_name}/versions/{version_name}"},{"label":"Copy a template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-templates/put-v3--domain-name--templates--template-name--copy","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-templates/put-v3--domain-name--templates--template-name--copy","metadata":{"seo":{"title":"Copy a template","description":"Copies an existing template into new templates with the provided names and account IDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v3--domain-name--templates--template-name--copy","name":"Copy a template","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1copy/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Copy a template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Copies an existing template into new templates with the provided names and account IDs."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain name the template is associated with.","required":true},{"name":"template_name","in":"path","schemaId":"components/schemas/string","description":"The name of the source template","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1copy/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyParams","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1copy/put/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyParams","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1copy/put/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1copy/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/{domain_name}/templates/{template_name}/copy","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"template_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyParams","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1copy/put/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["200","400","401","404","500"],"pointer":"/v3/{domain_name}/templates/{template_name}/copy","href":"domain-templates/put-v3--domain-name--templates--template-name--copy","openApiOperationId":"PUT-v3--domain-name--templates--template-name--copy","summary":"Copy a template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyParams","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1copy/put/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyParams","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1copy/put/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1copy/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1copy/put/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-ResponseWithStatus"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-ResponseWithStatus"},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1copy/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1copy/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1copy/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-ResponseWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-ResponseWithStatus"}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-templates/put-v3--domain-name--templates--template-name--copy"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/templates/{template_name}/copy"},{"label":"Copy a version","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-templates/put-v3--domain-name--templates--template-name--versions--version-name--copy--new-version-name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-templates/put-v3--domain-name--templates--template-name--versions--version-name--copy--new-version-name-","metadata":{"seo":{"title":"Copy a version","description":"Copies an existing version into a new version with the provided name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v3--domain-name--templates--template-name--versions--version-name--copy--new-version-name-","name":"Copy a version","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}~1copy~1{new_version_name}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Copy a version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Copies an existing version into a new version with the provided name."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain name the template is associated with.","required":true},{"name":"template_name","in":"path","schemaId":"components/schemas/string","description":"Template name the version is stored under.","required":true},{"name":"version_name","in":"path","schemaId":"components/schemas/string","description":"Tag of the version to copy.","required":true},{"name":"new_version_name","in":"path","schemaId":"components/schemas/string","description":"The name for the new version. If the version name already exists, the copy will fail.","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}~1copy~1{new_version_name}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"comment","in":"query","schemaId":"components/schemas/string","description":"Comment to be used for the new version."}],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}~1copy~1{new_version_name}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/{domain_name}/templates/{template_name}/versions/{version_name}/copy/{new_version_name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"template_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"version_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"new_version_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"comment","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v3/{domain_name}/templates/{template_name}/versions/{version_name}/copy/{new_version_name}","href":"domain-templates/put-v3--domain-name--templates--template-name--versions--version-name--copy--new-version-name-","openApiOperationId":"PUT-v3--domain-name--templates--template-name--versions--version-name--copy--new-version-name-","summary":"Copy a version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-versionCopyResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}~1copy~1{new_version_name}/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-versionCopyResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}~1copy~1{new_version_name}/put/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}~1copy~1{new_version_name}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-versionCopyResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}~1copy~1{new_version_name}/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-versionCopyResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}~1copy~1{new_version_name}/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-templates/put-v3--domain-name--templates--template-name--versions--version-name--copy--new-version-name-"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/templates/{template_name}/versions/{version_name}/copy/{new_version_name}"},{"label":"Rename a template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/domain-templates/put-v3--domain-name--templates--template-name--rename--new-template-name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/domain-templates/put-v3--domain-name--templates--template-name--rename--new-template-name-","metadata":{"seo":{"title":"Rename a template","description":"Renames the specified template"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v3--domain-name--templates--template-name--rename--new-template-name-","name":"Rename a template","isWebhook":false,"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1rename~1{new_template_name}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rename a template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Renames the specified template"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Domain name the template is associated with.","required":true},{"name":"template_name","in":"path","schemaId":"components/schemas/string","description":"The current name of the template.","required":true},{"name":"new_template_name","in":"path","schemaId":"components/schemas/string","description":"The name for the new template.","required":true}],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1rename~1{new_template_name}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/{domain_name}/templates/{template_name}/rename/{new_template_name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"template_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"new_template_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v3/{domain_name}/templates/{template_name}/rename/{new_template_name}","href":"domain-templates/put-v3--domain-name--templates--template-name--rename--new-template-name-","openApiOperationId":"PUT-v3--domain-name--templates--template-name--rename--new-template-name-","summary":"Rename a template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1rename~1{new_template_name}/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1rename~1{new_template_name}/put/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1{domain_name}~1templates~1{template_name}~1rename~1{new_template_name}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1rename~1{new_template_name}/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","exampleIds":["paths/~1v3~1{domain_name}~1templates~1{template_name}~1rename~1{new_template_name}/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-templates/put-v3--domain-name--templates--template-name--rename--new-template-name-"}],"panels":[]}]},"httpPath":"/v3/{domain_name}/templates/{template_name}/rename/{new_template_name}"}],"content":{"contentType":"group","meta":{"name":"Domain Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Domain Templates","showPageActions":true},{"nodeType":"markdoc","content":"This API allows you to store predefined templates at the domain level and use them to send messages using the Sending API."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/{domain_name}/templates","summary":"Get templates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain-templates/get-v3--domain-name--templates","deprecated":false},{"title":"/v3/{domain_name}/templates","summary":"Create a template","prefix":{"name":"post","color":"post"},"badges":[],"link":"/domain-templates/post-v3--domain-name--templates","deprecated":false},{"title":"/v3/{domain_name}/templates","summary":"Delete all templates","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/domain-templates/delete-v3--domain-name--templates","deprecated":false},{"title":"/v3/{domain_name}/templates/{template_name}/versions","summary":"Get all template versions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain-templates/get-v3--domain-name--templates--template-name--versions","deprecated":false},{"title":"/v3/{domain_name}/templates/{template_name}/versions","summary":"Create a template version","prefix":{"name":"post","color":"post"},"badges":[],"link":"/domain-templates/post-v3--domain-name--templates--template-name--versions","deprecated":false},{"title":"/v3/{domain_name}/templates/{template_name}","summary":"Get template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain-templates/get-v3--domain-name--templates--template-name-","deprecated":false},{"title":"/v3/{domain_name}/templates/{template_name}","summary":"Update template","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain-templates/put-v3--domain-name--templates--template-name-","deprecated":false},{"title":"/v3/{domain_name}/templates/{template_name}","summary":"Delete a template","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/domain-templates/delete-v3--domain-name--templates--template-name-","deprecated":false},{"title":"/v3/{domain_name}/templates/{template_name}/versions/{version_name}","summary":"Get a version","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain-templates/get-v3--domain-name--templates--template-name--versions--version-name-","deprecated":false},{"title":"/v3/{domain_name}/templates/{template_name}/versions/{version_name}","summary":"Update a version","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain-templates/put-v3--domain-name--templates--template-name--versions--version-name-","deprecated":false},{"title":"/v3/{domain_name}/templates/{template_name}/versions/{version_name}","summary":"Delete a version","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/domain-templates/delete-v3--domain-name--templates--template-name--versions--version-name-","deprecated":false},{"title":"/v3/{domain_name}/templates/{template_name}/copy","summary":"Copy a template","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain-templates/put-v3--domain-name--templates--template-name--copy","deprecated":false},{"title":"/v3/{domain_name}/templates/{template_name}/versions/{version_name}/copy/{new_version_name}","summary":"Copy a version","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain-templates/put-v3--domain-name--templates--template-name--versions--version-name--copy--new-version-name-","deprecated":false},{"title":"/v3/{domain_name}/templates/{template_name}/rename/{new_template_name}","summary":"Rename a template","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain-templates/put-v3--domain-name--templates--template-name--rename--new-template-name-","deprecated":false}]}]}]}]}},{"type":"separator","label":"IP Pools","content":null},{"type":"group","label":"IP Pools","link":"/docs/mailgun/api-reference/send/mailgun/ip-pools","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ip-pools","items":[{"label":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ip-pools/delete-v3-domains--name--ips--ip-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ip-pools/delete-v3-domains--name--ips--ip-","metadata":{"seo":{"title":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool","description":"The behavior of the endpoint depends on the value of the ip parameter. It can beone of the following:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3-domains--name--ips--ip-","name":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{name}~1ips~1{ip}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The behavior of the endpoint depends on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. It can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one of the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a valid IP address: this IP address will be removed from the domain pool."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the entire domain pool will be removed. As far as the system is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"concerned, such domain will no longer exist."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ip_pool"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the DIPP which is currently linked to the domain will be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unlinked."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"ips/delete-v3-domains--name--ips--ip-/request/ip-pools/delete-v3-domains--name--ips--ip-/request/removing-an-ip","deepLinkHash":"/ips/delete-v3-domains--name--ips--ip-#ips/delete-v3-domains--name--ips--ip-/request/ip-pools/delete-v3-domains--name--ips--ip-/request/removing-an-ip"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removing An IP"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that it's impossible to alter domain IPs if a DIPP is linked to the domain."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the account is not eligible for shared IPs, additional rules apply:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"removing the last IP from the domain is not allowed;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if all of the remaining dedicated IPs are on warmup, an extra IP might be added to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the domain pool."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"ips/delete-v3-domains--name--ips--ip-/request/ip-pools/delete-v3-domains--name--ips--ip-/request/unlinking-the-dipp","deepLinkHash":"/ips/delete-v3-domains--name--ips--ip-#ips/delete-v3-domains--name--ips--ip-/request/ip-pools/delete-v3-domains--name--ips--ip-/request/unlinking-the-dipp"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlinking The DIPP"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account must have 'DIPPs' feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pool_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter must be specified, but not both."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the special value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shared"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used for the replacement IP, the account must be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eligible for shared IPs. In this case the system will assign a shared IP as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"replacement."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ip","in":"path","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One of the following: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ip_pool"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a valid IP address."},"children":[]}]}]}],"required":true},{"name":"name","in":"path","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain name. Converted to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Mailgun-Domain-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header by the middleware."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v3~1domains~1{name}~1ips~1{ip}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ip","in":"query","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replacement IP or special value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shared"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"pool_id","in":"query","schemaId":"components/schemas/string","description":"Replacement DIPP id."}],"pointer":"/paths/~1v3~1domains~1{name}~1ips~1{ip}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/domains/{name}/ips/{ip}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"ip","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"ip","in":"query","schemaId":"components/schemas/string"},{"name":"pool_id","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/domains/{name}/ips/{ip}","href":"ip-pools/delete-v3-domains--name--ips--ip-","openApiOperationId":"DELETE-v3-domains--name--ips--ip-","summary":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1ips~1{ip}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1ips~1{ip}/delete/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{name}~1ips~1{ip}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1ips~1{ip}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1ips~1{ip}/delete/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-pools/delete-v3-domains--name--ips--ip-"}],"panels":[]}]},"httpPath":"/v3/domains/{name}/ips/{ip}"},{"label":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ip-pools/delete-v3-domains--name--pool--ip-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ip-pools/delete-v3-domains--name--pool--ip-","metadata":{"seo":{"title":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool","description":"The behavior of the endpoint depends on the value of the ip parameter. It can beone of the following:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3-domains--name--pool--ip-","name":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{name}~1pool~1{ip}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The behavior of the endpoint depends on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. It can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one of the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a valid IP address: this IP address will be removed from the domain pool."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the entire domain pool will be removed. As far as the system is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"concerned, such domain will no longer exist."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ip_pool"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the DIPP which is currently linked to the domain will be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unlinked."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"ips/delete-v3-domains--name--pool--ip-/request/ip-pools/delete-v3-domains--name--pool--ip-/request/removing-an-ip","deepLinkHash":"/ips/delete-v3-domains--name--pool--ip-#ips/delete-v3-domains--name--pool--ip-/request/ip-pools/delete-v3-domains--name--pool--ip-/request/removing-an-ip"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removing An IP"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that it's impossible to alter domain IPs if a DIPP is linked to the domain."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the account is not eligible for shared IPs, additional rules apply:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"removing the last IP from the domain is not allowed;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if all of the remaining dedicated IPs are on warmup, an extra IP might be added to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the domain pool."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"ips/delete-v3-domains--name--pool--ip-/request/ip-pools/delete-v3-domains--name--pool--ip-/request/unlinking-the-dipp","deepLinkHash":"/ips/delete-v3-domains--name--pool--ip-#ips/delete-v3-domains--name--pool--ip-/request/ip-pools/delete-v3-domains--name--pool--ip-/request/unlinking-the-dipp"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlinking The DIPP"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account must have 'DIPPs' feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pool_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter must be specified, but not both."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the special value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shared"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used for the replacement IP, the account must be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eligible for shared IPs. In this case the system will assign a shared IP as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"replacement."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ip","in":"path","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One of the following: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ip_pool"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a valid IP address."},"children":[]}]}]}],"required":true},{"name":"name","in":"path","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain name. Converted to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Mailgun-Domain-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header by the middleware."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v3~1domains~1{name}~1pool~1{ip}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ip","in":"query","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replacement IP or special value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shared"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"pool_id","in":"query","schemaId":"components/schemas/string","description":"Replacement DIPP id."}],"pointer":"/paths/~1v3~1domains~1{name}~1pool~1{ip}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/domains/{name}/pool/{ip}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"ip","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"ip","in":"query","schemaId":"components/schemas/string"},{"name":"pool_id","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/domains/{name}/pool/{ip}","href":"ip-pools/delete-v3-domains--name--pool--ip-","openApiOperationId":"DELETE-v3-domains--name--pool--ip-","summary":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1pool~1{ip}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1pool~1{ip}/delete/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{name}~1pool~1{ip}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1pool~1{ip}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1pool~1{ip}/delete/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-pools/delete-v3-domains--name--pool--ip-"}],"panels":[]}]},"httpPath":"/v3/domains/{name}/pool/{ip}"},{"label":"List dedicated IP pools of the account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ip-pools/get-v3-ip-pools","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ip-pools/get-v3-ip-pools","metadata":{"seo":{"title":"List dedicated IP pools of the account","description":"Description"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-ip-pools","name":"List dedicated IP pools of the account","isWebhook":false,"pointer":"/paths/~1v3~1ip_pools/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List dedicated IP pools of the account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"ip-pools/get-v3-ip-pools/request/description","deepLinkHash":"/ip-pools/get-v3-ip-pools#ip-pools/get-v3-ip-pools/request/description"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all dedicated IP pools of the account. For each pool"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returns its basic properties (name, description, the list of IPs)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and indicates whether the pool is linked to any domains and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"whether it's an inherited one."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/ip_pools","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/ip_pools","href":"ip-pools/get-v3-ip-pools","openApiOperationId":"GET-v3-ip-pools","summary":"List dedicated IP pools of the account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-ip_pools-list-successResponse","exampleIds":["paths/~1v3~1ip_pools/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-tower-api-ip_pools-list-successResponse","exampleIds":["paths/~1v3~1ip_pools/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ip_pools/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ip_pools/get/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1ip_pools/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-tower-api-ip_pools-list-successResponse","exampleIds":["paths/~1v3~1ip_pools/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-ip_pools-list-successResponse","exampleIds":["paths/~1v3~1ip_pools/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ip_pools/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ip_pools/get/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-pools/get-v3-ip-pools"}],"panels":[]}]},"httpPath":"/v3/ip_pools"},{"label":"Add a new DIPP to the account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ip-pools/post-v3-ip-pools","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ip-pools/post-v3-ip-pools","metadata":{"seo":{"title":"Add a new DIPP to the account","description":"The account must have 'DIPPs' feature enabled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3-ip-pools","name":"Add a new DIPP to the account","isWebhook":false,"pointer":"/paths/~1v3~1ip_pools/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a new DIPP to the account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The account must have 'DIPPs' feature enabled.\n\nReturns the id of the newly created DIPP."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-ip_pools-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/POST-v3-ip_pools-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1ip_pools/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/ip_pools","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-ip_pools-multipart-form-data-RequestBody"}},"responseCodes":["200"],"pointer":"/v3/ip_pools","href":"ip-pools/post-v3-ip-pools","openApiOperationId":"POST-v3-ip-pools","summary":"Add a new DIPP to the account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/POST-v3-ip_pools-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-ip_pools-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools/post/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1ip_pools/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools/post/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-pools/post-v3-ip-pools"}],"panels":[]}]},"httpPath":"/v3/ip_pools"},{"label":"Get DIPP details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ip-pools/get-v3-ip-pools--pool-id-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ip-pools/get-v3-ip-pools--pool-id-","metadata":{"seo":{"title":"Get DIPP details","description":"is_linked in the response indicates whether the DIPP is currently linked to anydomains. If it's true, linked_domain lists those domains."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-ip-pools--pool-id-","name":"Get DIPP details","isWebhook":false,"pointer":"/paths/~1v3~1ip_pools~1{pool_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get DIPP details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_linked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response indicates whether the DIPP is currently linked to any"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"domains. If it's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_domain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" lists those domains."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pool_id","in":"path","schemaId":"components/schemas/string","description":"Id of the DIPP to get details about","required":true}],"pointer":"/paths/~1v3~1ip_pools~1{pool_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/ip_pools/{pool_id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"pool_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/ip_pools/{pool_id}","href":"ip-pools/get-v3-ip-pools--pool-id-","openApiOperationId":"GET-v3-ip-pools--pool-id-","summary":"Get DIPP details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1ip_pools~1{pool_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-pools/get-v3-ip-pools--pool-id-"}],"panels":[]}]},"httpPath":"/v3/ip_pools/{pool_id}"},{"label":"Delete the DIPP","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ip-pools/delete-v3-ip-pools--pool-id-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ip-pools/delete-v3-ip-pools--pool-id-","metadata":{"seo":{"title":"Delete the DIPP","description":"The DIPPs feature must be enabled for the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3-ip-pools--pool-id-","name":"Delete the DIPP","isWebhook":false,"pointer":"/paths/~1v3~1ip_pools~1{pool_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete the DIPP","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DIPPs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature must be enabled for the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is not allowed to delete a DIPP inherited from the parent account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the DIPP is delegated to subaccounts, those will also be updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the replacement DIPP is specified, all domains linked to the deleted DIPP will be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"relinked to the replacement DIPP. The latter must contain at least one IP."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the replacement IP is specified, all domains linked to the deleted DIPP will be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unlinked, and the replacement IP will be assigned to them. It is not allowed to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delete a DIPP inherited from the parent account and replace it with an IP"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(subaccounts do not explicitly manage their IPs)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The replacement IP must be a dedicated one; it can't belong to another DIPP. If a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"special value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shared"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used, appropriate shared IPs will be used (the account must"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be eligible for shared IPs in this case)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omitting both replacement DIPP and replacement IP is allowed only if the DIPP being"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deleted contains no IPs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The processing of affected domains and subaccounts happens asynchronously after the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoint returns a response."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pool_id","in":"path","schemaId":"components/schemas/string","description":"Id of the DIPP to delete","required":true}],"pointer":"/paths/~1v3~1ip_pools~1{pool_id}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ip","in":"query","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replacement IP or a special value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shared"},"children":[]}]}]}],"required":true},{"name":"pool_id","in":"query","schemaId":"components/schemas/string","description":"Id of the replacement DIPP","required":true}],"pointer":"/paths/~1v3~1ip_pools~1{pool_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/ip_pools/{pool_id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"pool_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"ip","in":"query","required":true,"schemaId":"components/schemas/string"},{"name":"pool_id","in":"query","required":true,"schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/ip_pools/{pool_id}","href":"ip-pools/delete-v3-ip-pools--pool-id-","openApiOperationId":"DELETE-v3-ip-pools--pool-id-","summary":"Delete the DIPP"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}/delete/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1ip_pools~1{pool_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}/delete/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-pools/delete-v3-ip-pools--pool-id-"}],"panels":[]}]},"httpPath":"/v3/ip_pools/{pool_id}"},{"label":"Edit DIPP","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ip-pools/patch-v3-ip-pools--pool-id-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ip-pools/patch-v3-ip-pools--pool-id-","metadata":{"seo":{"title":"Edit DIPP","description":"The account must have 'DIPPs' feature enabled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PATCH-v3-ip-pools--pool-id-","name":"Edit DIPP","isWebhook":false,"pointer":"/paths/~1v3~1ip_pools~1{pool_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit DIPP","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The account must have 'DIPPs' feature enabled.\n\nIt's not allowed to edit a DIPP inherited from the parent account.\n\nIPs being added to the DIPP must be dedicated ones and belong to the account.\n\nIf IPs of the DIPP end up modified, and the DIPP is linked to domains, the domains\nwill be updated asynchronously (after this endpoint returns response).\n\nReturns an error if the passed parameters won't result in any changes."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pool_id","in":"path","schemaId":"components/schemas/string","description":"Id of the DIPP to edit","required":true}],"pointer":"/paths/~1v3~1ip_pools~1{pool_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PATCH-v3-ip_pools-pool_id-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/PATCH-v3-ip_pools-pool_id-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1ip_pools~1{pool_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v3/ip_pools/{pool_id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"pool_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/PATCH-v3-ip_pools-pool_id-multipart-form-data-RequestBody"}},"responseCodes":["200"],"pointer":"/v3/ip_pools/{pool_id}","href":"ip-pools/patch-v3-ip-pools--pool-id-","openApiOperationId":"PATCH-v3-ip-pools--pool-id-","summary":"Edit DIPP"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/PATCH-v3-ip_pools-pool_id-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PATCH-v3-ip_pools-pool_id-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}/patch/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}/patch/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1ip_pools~1{pool_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}/patch/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}/patch/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-pools/patch-v3-ip-pools--pool-id-"}],"panels":[]}]},"httpPath":"/v3/ip_pools/{pool_id}"},{"label":"Get domains linked to DIPP","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ip-pools/get-v3-ip-pools--pool-id--domains","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ip-pools/get-v3-ip-pools--pool-id--domains","metadata":{"seo":{"title":"Get domains linked to DIPP","description":"Returns a paginated list of domains that are linked to the specified dedicated IP pool."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-ip-pools--pool-id--domains","name":"Get domains linked to DIPP","isWebhook":false,"pointer":"/paths/~1v3~1ip_pools~1{pool_id}~1domains/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get domains linked to DIPP","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of domains that are linked to the specified\ndedicated IP pool."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pool_id","in":"path","schemaId":"components/schemas/string","description":"Id of the DIPP to get details about","required":true}],"pointer":"/paths/~1v3~1ip_pools~1{pool_id}~1domains/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_294","description":"The maximum number of records to return"},{"name":"page","in":"query","schemaId":"components/schemas/string","description":"Encoded page identifier retrieved from previous call"}],"pointer":"/paths/~1v3~1ip_pools~1{pool_id}~1domains/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/ip_pools/{pool_id}/domains","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"pool_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"limit","in":"query","schemaId":"schema_294"},{"name":"page","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/ip_pools/{pool_id}/domains","href":"ip-pools/get-v3-ip-pools--pool-id--domains","openApiOperationId":"GET-v3-ip-pools--pool-id--domains","summary":"Get domains linked to DIPP"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1domains/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1domains/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1ip_pools~1{pool_id}~1domains/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1domains/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1domains/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-pools/get-v3-ip-pools--pool-id--domains"}],"panels":[]}]},"httpPath":"/v3/ip_pools/{pool_id}/domains"},{"label":"Add an IP to a DIPP","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ip-pools/put-v3-ip-pools--pool-id--ips--ip-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ip-pools/put-v3-ip-pools--pool-id--ips--ip-","metadata":{"seo":{"title":"Add an IP to a DIPP","description":"The account must have 'DIPPs' feature enabled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v3-ip-pools--pool-id--ips--ip-","name":"Add an IP to a DIPP","isWebhook":false,"pointer":"/paths/~1v3~1ip_pools~1{pool_id}~1ips~1{ip}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add an IP to a DIPP","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The account must have 'DIPPs' feature enabled.\n\nIt is not allowed to modify a DIPP inherited from the parent account.\n\nThe IP must be a dedicated one, belong to the account and not belong to any other\nDIPP.\n\nAll domains linked to the DIPP will be updated so that their IPs include the newly\nadded address. If the DIPP is delegated to subaccounts, those will also be updated.\n\nThe processing of affected domains and subaccounts happens asynchronously after the\nendpoint returns a response."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ip","in":"path","schemaId":"components/schemas/string","description":"IP to add to the DIPP","required":true},{"name":"pool_id","in":"path","schemaId":"components/schemas/string","description":"Id of the DIPP to update","required":true}],"pointer":"/paths/~1v3~1ip_pools~1{pool_id}~1ips~1{ip}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/ip_pools/{pool_id}/ips/{ip}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"ip","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"pool_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/ip_pools/{pool_id}/ips/{ip}","href":"ip-pools/put-v3-ip-pools--pool-id--ips--ip-","openApiOperationId":"PUT-v3-ip-pools--pool-id--ips--ip-","summary":"Add an IP to a DIPP"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1ips~1{ip}/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1ips~1{ip}/put/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1ip_pools~1{pool_id}~1ips~1{ip}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1ips~1{ip}/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1ips~1{ip}/put/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-pools/put-v3-ip-pools--pool-id--ips--ip-"}],"panels":[]}]},"httpPath":"/v3/ip_pools/{pool_id}/ips/{ip}"},{"label":"Remove an IP from a DIPP","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ip-pools/delete-v3-ip-pools--pool-id--ips--ip-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ip-pools/delete-v3-ip-pools--pool-id--ips--ip-","metadata":{"seo":{"title":"Remove an IP from a DIPP","description":"The account must have 'DIPPs' feature enabled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3-ip-pools--pool-id--ips--ip-","name":"Remove an IP from a DIPP","isWebhook":false,"pointer":"/paths/~1v3~1ip_pools~1{pool_id}~1ips~1{ip}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove an IP from a DIPP","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The account must have 'DIPPs' feature enabled.\n\nIt's not allowed to edit a DIPP inherited from the parent account.\n\nIf the DIPP is linked to domains, the domains will be updated asynchronously (after\nthis endpoint returns response)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ip","in":"path","schemaId":"components/schemas/string","description":"The IP to remove","required":true},{"name":"pool_id","in":"path","schemaId":"components/schemas/string","description":"The id of the DIPP","required":true}],"pointer":"/paths/~1v3~1ip_pools~1{pool_id}~1ips~1{ip}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/ip_pools/{pool_id}/ips/{ip}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"ip","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"pool_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/ip_pools/{pool_id}/ips/{ip}","href":"ip-pools/delete-v3-ip-pools--pool-id--ips--ip-","openApiOperationId":"DELETE-v3-ip-pools--pool-id--ips--ip-","summary":"Remove an IP from a DIPP"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1ips~1{ip}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1ips~1{ip}/delete/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1ip_pools~1{pool_id}~1ips~1{ip}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1ips~1{ip}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1ips~1{ip}/delete/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-pools/delete-v3-ip-pools--pool-id--ips--ip-"}],"panels":[]}]},"httpPath":"/v3/ip_pools/{pool_id}/ips/{ip}"},{"label":"Add multiple IPs to the DIPP","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ip-pools/post-v3-ip-pools--pool-id--ips-json","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ip-pools/post-v3-ip-pools--pool-id--ips-json","metadata":{"seo":{"title":"Add multiple IPs to the DIPP","description":"The account must have 'DIPPs' feature enabled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3-ip-pools--pool-id--ips-json","name":"Add multiple IPs to the DIPP","isWebhook":false,"pointer":"/paths/~1v3~1ip_pools~1{pool_id}~1ips.json/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add multiple IPs to the DIPP","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The account must have 'DIPPs' feature enabled.\n\nIt is not allowed to modify a DIPP inherited from the parent account.\n\nAll IPs must be dedicated ones, belong to the account and not belong to any other\nDIPP.\n\nAll domains linked to the DIPP will be updated so that their IPs include the newly\nadded addresses. If the DIPP is delegated to subaccounts, those will also be updated.\n\nThe processing of affected domains and subaccounts happens asynchronously after the\nendpoint returns a response."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pool_id","in":"path","schemaId":"components/schemas/string","description":"Id of the DIPP to update","required":true}],"pointer":"/paths/~1v3~1ip_pools~1{pool_id}~1ips.json/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-ip_pools-add_ip-addMultipleIPsRequestBody","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1ips.json/post/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-tower-api-ip_pools-add_ip-addMultipleIPsRequestBody","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1ips.json/post/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v3~1ip_pools~1{pool_id}~1ips.json/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/ip_pools/{pool_id}/ips.json","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"pool_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-ip_pools-add_ip-addMultipleIPsRequestBody","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1ips.json/post/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["200"],"pointer":"/v3/ip_pools/{pool_id}/ips.json","href":"ip-pools/post-v3-ip-pools--pool-id--ips-json","openApiOperationId":"POST-v3-ip-pools--pool-id--ips-json","summary":"Add multiple IPs to the DIPP"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-tower-api-ip_pools-add_ip-addMultipleIPsRequestBody","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1ips.json/post/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-ip_pools-add_ip-addMultipleIPsRequestBody","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1ips.json/post/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1ips.json/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1ips.json/post/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1ip_pools~1{pool_id}~1ips.json/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1ips.json/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1ips.json/post/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-pools/post-v3-ip-pools--pool-id--ips-json"}],"panels":[]}]},"httpPath":"/v3/ip_pools/{pool_id}/ips.json"},{"label":"Delegate DIPP to Subaccount","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ip-pools/put-v3-ip-pools--pool-id--delegate","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ip-pools/put-v3-ip-pools--pool-id--delegate","metadata":{"seo":{"title":"Delegate DIPP to Subaccount","description":"Delegates a dedicated IP pool (DIPP) from the parent account to a specified subaccount. Unlike legacy endpoints, this supports accounts with multiple delegated DIPPs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v3-ip-pools--pool-id--delegate","name":"Delegate DIPP to Subaccount","isWebhook":false,"pointer":"/paths/~1v3~1ip_pools~1{pool_id}~1delegate/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delegate DIPP to Subaccount","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delegates a dedicated IP pool (DIPP) from the parent account to a specified subaccount.\nUnlike legacy endpoints, this supports accounts with multiple delegated DIPPs.\n\nRequest parameters are encoded as form data."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pool_id","in":"path","schemaId":"components/schemas/string","description":"The ID of the dedicated IP pool to delegate","required":true}],"pointer":"/paths/~1v3~1ip_pools~1{pool_id}~1delegate/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-ip_pools-pool_id-delegate-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/PUT-v3-ip_pools-pool_id-delegate-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1ip_pools~1{pool_id}~1delegate/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/ip_pools/{pool_id}/delegate","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"pool_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-ip_pools-pool_id-delegate-multipart-form-data-RequestBody"}},"responseCodes":["200"],"pointer":"/v3/ip_pools/{pool_id}/delegate","href":"ip-pools/put-v3-ip-pools--pool-id--delegate","openApiOperationId":"PUT-v3-ip-pools--pool-id--delegate","summary":"Delegate DIPP to Subaccount"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/PUT-v3-ip_pools-pool_id-delegate-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-ip_pools-pool_id-delegate-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1delegate/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1delegate/put/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1ip_pools~1{pool_id}~1delegate/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1delegate/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1delegate/put/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-pools/put-v3-ip-pools--pool-id--delegate"}],"panels":[]}]},"httpPath":"/v3/ip_pools/{pool_id}/delegate"},{"label":"Revoke DIPP from Subaccount","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ip-pools/delete-v3-ip-pools--pool-id--delegate","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ip-pools/delete-v3-ip-pools--pool-id--delegate","metadata":{"seo":{"title":"Revoke DIPP from Subaccount","description":"Revokes delegation of a dedicated IP pool (DIPP) from a specified subaccount. The DIPP will no longer be available to the subaccount. Unlike legacy endpoints, this supports accounts with multiple delegated DIPPs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3-ip-pools--pool-id--delegate","name":"Revoke DIPP from Subaccount","isWebhook":false,"pointer":"/paths/~1v3~1ip_pools~1{pool_id}~1delegate/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revoke DIPP from Subaccount","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Revokes delegation of a dedicated IP pool (DIPP) from a specified subaccount.\nThe DIPP will no longer be available to the subaccount. Unlike\nlegacy endpoints, this supports accounts with multiple delegated DIPPs.\n\nRequest parameters are encoded as form data."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pool_id","in":"path","schemaId":"components/schemas/string","description":"The ID of the dedicated IP pool to revoke","required":true}],"pointer":"/paths/~1v3~1ip_pools~1{pool_id}~1delegate/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/DELETE-v3-ip_pools-pool_id-delegate-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/DELETE-v3-ip_pools-pool_id-delegate-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1ip_pools~1{pool_id}~1delegate/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/ip_pools/{pool_id}/delegate","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"pool_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/DELETE-v3-ip_pools-pool_id-delegate-multipart-form-data-RequestBody"}},"responseCodes":["200"],"pointer":"/v3/ip_pools/{pool_id}/delegate","href":"ip-pools/delete-v3-ip-pools--pool-id--delegate","openApiOperationId":"DELETE-v3-ip-pools--pool-id--delegate","summary":"Revoke DIPP from Subaccount"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/DELETE-v3-ip_pools-pool_id-delegate-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/DELETE-v3-ip_pools-pool_id-delegate-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1delegate/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1delegate/delete/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1ip_pools~1{pool_id}~1delegate/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1delegate/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ip_pools~1{pool_id}~1delegate/delete/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-pools/delete-v3-ip-pools--pool-id--delegate"}],"panels":[]}]},"httpPath":"/v3/ip_pools/{pool_id}/delegate"}],"content":{"contentType":"group","meta":{"name":"IP Pools"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"IP Pools","showPageActions":true},{"nodeType":"markdoc","content":"IP Pools allow you to group your dedicated IPs into customized \"pools\" to help manage your sending reputation for different mail sending streams."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/domains/{name}/ips/{ip}","summary":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/ip-pools/delete-v3-domains--name--ips--ip-","deprecated":false},{"title":"/v3/domains/{name}/pool/{ip}","summary":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/ip-pools/delete-v3-domains--name--pool--ip-","deprecated":false},{"title":"/v3/ip_pools","summary":"List dedicated IP pools of the account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ip-pools/get-v3-ip-pools","deprecated":false},{"title":"/v3/ip_pools","summary":"Add a new DIPP to the account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ip-pools/post-v3-ip-pools","deprecated":false},{"title":"/v3/ip_pools/{pool_id}","summary":"Get DIPP details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ip-pools/get-v3-ip-pools--pool-id-","deprecated":false},{"title":"/v3/ip_pools/{pool_id}","summary":"Delete the DIPP","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/ip-pools/delete-v3-ip-pools--pool-id-","deprecated":false},{"title":"/v3/ip_pools/{pool_id}","summary":"Edit DIPP","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/ip-pools/patch-v3-ip-pools--pool-id-","deprecated":false},{"title":"/v3/ip_pools/{pool_id}/domains","summary":"Get domains linked to DIPP","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ip-pools/get-v3-ip-pools--pool-id--domains","deprecated":false},{"title":"/v3/ip_pools/{pool_id}/ips/{ip}","summary":"Add an IP to a DIPP","prefix":{"name":"put","color":"put"},"badges":[],"link":"/ip-pools/put-v3-ip-pools--pool-id--ips--ip-","deprecated":false},{"title":"/v3/ip_pools/{pool_id}/ips/{ip}","summary":"Remove an IP from a DIPP","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/ip-pools/delete-v3-ip-pools--pool-id--ips--ip-","deprecated":false},{"title":"/v3/ip_pools/{pool_id}/ips.json","summary":"Add multiple IPs to the DIPP","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ip-pools/post-v3-ip-pools--pool-id--ips-json","deprecated":false},{"title":"/v3/ip_pools/{pool_id}/delegate","summary":"Delegate DIPP to Subaccount","prefix":{"name":"put","color":"put"},"badges":[],"link":"/ip-pools/put-v3-ip-pools--pool-id--delegate","deprecated":false},{"title":"/v3/ip_pools/{pool_id}/delegate","summary":"Revoke DIPP from Subaccount","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/ip-pools/delete-v3-ip-pools--pool-id--delegate","deprecated":false}]}]}]}]}},{"type":"group","label":"Dynamic IP Pools","link":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools","routeSlug":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools","items":[{"label":"Enroll domain","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/post-v3-domains--name--dynamic-pools","routeSlug":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/post-v3-domains--name--dynamic-pools","metadata":{"seo":{"title":"Enroll domain","description":"Domains enrolled in the Dynamic IP pools feature will be assigned an IP pool based on reputation. The feature must be enabled and configured before enrolling domains."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3-domains--name--dynamic-pools","name":"Enroll domain","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{name}~1dynamic_pools/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enroll domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Domains enrolled in the Dynamic IP pools feature will be assigned an IP pool based on reputation.\nThe feature must be enabled and configured before enrolling domains."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"Domain name","required":true}],"pointer":"/paths/~1v3~1domains~1{name}~1dynamic_pools/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"replacement_ip","in":"query","schemaId":"components/schemas/string","description":"A valid IP address or 'shared'","required":true}],"pointer":"/paths/~1v3~1domains~1{name}~1dynamic_pools/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/domains/{name}/dynamic_pools","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"replacement_ip","in":"query","required":true,"schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/domains/{name}/dynamic_pools","href":"dynamic-ip-pools/post-v3-domains--name--dynamic-pools","openApiOperationId":"POST-v3-domains--name--dynamic-pools","summary":"Enroll domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dynamic_pools/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dynamic_pools/post/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{name}~1dynamic_pools/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dynamic_pools/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dynamic_pools/post/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dynamic-ip-pools/post-v3-domains--name--dynamic-pools"}],"panels":[]}]},"httpPath":"/v3/domains/{name}/dynamic_pools"},{"label":"Remove domain from dynamic IP pools","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/delete-v3-domains--name--dynamic-pools","routeSlug":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/delete-v3-domains--name--dynamic-pools","metadata":{"seo":{"title":"Remove domain from dynamic IP pools","description":"The behavior of this endpoint depends on the value of the replacement_ip and replacement_pool_id parameters.One of these parameters (but not both) must be provided. If replacement_ip is provided, the IP(s) will be assigned to the domain.replacement_ip can include one of the following:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3-domains--name--dynamic-pools","name":"Remove domain from dynamic IP pools","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{name}~1dynamic_pools/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove domain from dynamic IP pools","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The behavior of this endpoint depends on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"replacement_ip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"replacement_pool_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameters."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One of these parameters (but not both) must be provided. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"replacement_ip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, the IP(s) will be assigned to the domain."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"replacement_ip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can include one of the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"valid IP(s): this IP address or addresses will be added to the domain"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shared"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": if the account is eligible for shared IPs, a suitable shared IP will be chosen and added to the domain"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 'replacement_ip' parameter cannot include any IPs that are already assigned to a Dedicated IP Pool or a Dynamic IP Pool."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"replacement_pool_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, the Dedicated IP Pool will be assigned to the domain."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"Domain name","required":true}],"pointer":"/paths/~1v3~1domains~1{name}~1dynamic_pools/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"replacement_ip","in":"query","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid IP address or 'shared'. This field can be specified multiple times if all provided IPs are dedicated. Cannot be provided if providing 'replacement_pool_id' param"},"children":[]}]}]}],"required":true},{"name":"replacement_pool_id","in":"query","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid dedicated IP pool ID to assign to the domain. Cannot be provided if providing 'replacement_ip' param"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v3~1domains~1{name}~1dynamic_pools/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/domains/{name}/dynamic_pools","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"replacement_ip","in":"query","required":true,"schemaId":"components/schemas/string"},{"name":"replacement_pool_id","in":"query","required":true,"schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/domains/{name}/dynamic_pools","href":"dynamic-ip-pools/delete-v3-domains--name--dynamic-pools","openApiOperationId":"DELETE-v3-domains--name--dynamic-pools","summary":"Remove domain from dynamic IP pools"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dynamic_pools/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dynamic_pools/delete/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{name}~1dynamic_pools/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dynamic_pools/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1dynamic_pools/delete/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dynamic-ip-pools/delete-v3-domains--name--dynamic-pools"}],"panels":[]}]},"httpPath":"/v3/domains/{name}/dynamic_pools"},{"label":"List assignable domains","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/get-v3-domains-dynamic-pools-assignable","routeSlug":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/get-v3-domains-dynamic-pools-assignable","metadata":{"seo":{"title":"List assignable domains","description":"Lists all domains that are not already enrolled in dynamic IP pools."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-domains-dynamic-pools-assignable","name":"List assignable domains","isWebhook":false,"pointer":"/paths/~1v3~1domains~1dynamic_pools~1assignable/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List assignable domains","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all domains that are not already enrolled in dynamic IP pools."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"subaccount_id","in":"query","schemaId":"components/schemas/string","description":"If provided, queries domains belonging to the subaccount. Must be a valid account ID"},{"name":"domain","in":"query","schemaId":"components/schemas/string","description":"Regex search term to query a domain by name"}],"pointer":"/paths/~1v3~1domains~1dynamic_pools~1assignable/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/domains/dynamic_pools/assignable","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"subaccount_id","in":"query","schemaId":"components/schemas/string"},{"name":"domain","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/domains/dynamic_pools/assignable","href":"dynamic-ip-pools/get-v3-domains-dynamic-pools-assignable","openApiOperationId":"GET-v3-domains-dynamic-pools-assignable","summary":"List assignable domains"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1dynamic_pools~1assignable/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1dynamic_pools~1assignable/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1dynamic_pools~1assignable/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1dynamic_pools~1assignable/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1dynamic_pools~1assignable/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dynamic-ip-pools/get-v3-domains-dynamic-pools-assignable"}],"panels":[]}]},"httpPath":"/v3/domains/dynamic_pools/assignable"},{"label":"Enroll all account domains","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/post-v3-domains-all-dynamic-pools-enroll","routeSlug":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/post-v3-domains-all-dynamic-pools-enroll","metadata":{"seo":{"title":"Enroll all account domains","description":"Begins an asynchronous background job to assign all domains to Dynamic IP Pools. This can also include domains belonging to subaccounts depending on the provided parameters. The Dynamic IP Pools feature must be enabled for the account and the request must come from a parent account user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3-domains-all-dynamic-pools-enroll","name":"Enroll all account domains","isWebhook":false,"pointer":"/paths/~1v3~1domains~1all~1dynamic_pools~1enroll/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enroll all account domains","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Begins an asynchronous background job to assign all domains to Dynamic IP Pools.\nThis can also include domains belonging to subaccounts depending on the provided parameters.\nThe Dynamic IP Pools feature must be enabled for the account and the request must come from a parent account user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_subaccounts","in":"query","schemaId":"schema_264","description":"If true, domains belonging to subaccounts will also be enrolled in Dynamic IP Pools","required":true}],"pointer":"/paths/~1v3~1domains~1all~1dynamic_pools~1enroll/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/domains/all/dynamic_pools/enroll","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"include_subaccounts","in":"query","required":true,"schemaId":"schema_264"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/domains/all/dynamic_pools/enroll","href":"dynamic-ip-pools/post-v3-domains-all-dynamic-pools-enroll","openApiOperationId":"POST-v3-domains-all-dynamic-pools-enroll","summary":"Enroll all account domains"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1all~1dynamic_pools~1enroll/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1all~1dynamic_pools~1enroll/post/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1all~1dynamic_pools~1enroll/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1all~1dynamic_pools~1enroll/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1all~1dynamic_pools~1enroll/post/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dynamic-ip-pools/post-v3-domains-all-dynamic-pools-enroll"}],"panels":[]}]},"httpPath":"/v3/domains/all/dynamic_pools/enroll"},{"label":"List all Dynamic IP pools","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/get-v3-dynamic-pools","routeSlug":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/get-v3-dynamic-pools","metadata":{"seo":{"title":"List all Dynamic IP pools","description":"Returns the list of IPs belonging to each of the account's Dynamic IP Pools."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-dynamic-pools","name":"List all Dynamic IP pools","isWebhook":false,"pointer":"/paths/~1v3~1dynamic_pools/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all Dynamic IP pools","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of IPs belonging to each of the account's Dynamic IP Pools."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/dynamic_pools","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/dynamic_pools","href":"dynamic-ip-pools/get-v3-dynamic-pools","openApiOperationId":"GET-v3-dynamic-pools","summary":"List all Dynamic IP pools"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v3~1dynamic_pools/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v3~1dynamic_pools/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1dynamic_pools/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v3~1dynamic_pools/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v3~1dynamic_pools/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dynamic-ip-pools/get-v3-dynamic-pools"}],"panels":[]}]},"httpPath":"/v3/dynamic_pools"},{"label":"Initialize/set IPs for all pools","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/post-v3-dynamic-pools-all","routeSlug":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/post-v3-dynamic-pools-all","metadata":{"seo":{"title":"Initialize/set IPs for all pools","description":"Any existing IPs in dynamic IP pools will be replaced. All IPs must be dedicated IPs and belong to the account. Additionally, each dynamic IP pool must contain at least 1 IP that is not currently warming."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3-dynamic-pools-all","name":"Initialize/set IPs for all pools","isWebhook":false,"pointer":"/paths/~1v3~1dynamic_pools~1all/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initialize/set IPs for all pools","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Any existing IPs in dynamic IP pools will be replaced. All IPs must be dedicated IPs and\nbelong to the account. Additionally, each dynamic IP pool must contain at least 1 IP that\nis not currently warming."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-dynamic_pools-all-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/POST-v3-dynamic_pools-all-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1dynamic_pools~1all/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/dynamic_pools/all","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-dynamic_pools-all-multipart-form-data-RequestBody"}},"responseCodes":["200"],"pointer":"/v3/dynamic_pools/all","href":"dynamic-ip-pools/post-v3-dynamic-pools-all","openApiOperationId":"POST-v3-dynamic-pools-all","summary":"Initialize/set IPs for all pools"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/POST-v3-dynamic_pools-all-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-dynamic_pools-all-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1dynamic_pools~1all/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1dynamic_pools~1all/post/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1dynamic_pools~1all/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1dynamic_pools~1all/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1dynamic_pools~1all/post/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dynamic-ip-pools/post-v3-dynamic-pools-all"}],"panels":[]}]},"httpPath":"/v3/dynamic_pools/all"},{"label":"Remove all dynamic IP pools","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/delete-v3-dynamic-pools-all","routeSlug":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/delete-v3-dynamic-pools-all","metadata":{"seo":{"title":"Remove all dynamic IP pools","description":"Removes all dynamic IP pools from the account. All domains on the account (and subaccounts, if any) must be removed from dynamic IP pools before the pools can be removed. Any standard dedicated IP pools will not be modified."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3-dynamic-pools-all","name":"Remove all dynamic IP pools","isWebhook":false,"pointer":"/paths/~1v3~1dynamic_pools~1all/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove all dynamic IP pools","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes all dynamic IP pools from the account. All domains on the account (and subaccounts, if any) must be removed from dynamic IP pools before the pools can be removed. Any standard dedicated IP pools will not be modified."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/dynamic_pools/all","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/dynamic_pools/all","href":"dynamic-ip-pools/delete-v3-dynamic-pools-all","openApiOperationId":"DELETE-v3-dynamic-pools-all","summary":"Remove all dynamic IP pools"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1dynamic_pools~1all/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1dynamic_pools~1all/delete/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1dynamic_pools~1all/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1dynamic_pools~1all/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1dynamic_pools~1all/delete/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dynamic-ip-pools/delete-v3-dynamic-pools-all"}],"panels":[]}]},"httpPath":"/v3/dynamic_pools/all"},{"label":"Add IP to Dynamic IP Pool","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/post-v3-dynamic-pools--pool-name---ip-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/post-v3-dynamic-pools--pool-name---ip-","metadata":{"seo":{"title":"Add IP to Dynamic IP Pool","description":"Adds a given IP to a Dynamic IP Pool. The IP must be dedicated and belong to the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3-dynamic-pools--pool-name---ip-","name":"Add IP to Dynamic IP Pool","isWebhook":false,"pointer":"/paths/~1v3~1dynamic_pools~1{pool_name}~1{ip}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add IP to Dynamic IP Pool","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a given IP to a Dynamic IP Pool. The IP must be dedicated and belong to the account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pool_name","in":"path","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the Dynamic IP Pool to add the IP to (ex: dynamic_good, dynamic_poor, etc.)"},"children":[]}]}]}],"required":true},{"name":"ip","in":"path","schemaId":"components/schemas/string","description":"The ip to add to the given Dynamic IP Pool","required":true}],"pointer":"/paths/~1v3~1dynamic_pools~1{pool_name}~1{ip}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/dynamic_pools/{pool_name}/{ip}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"pool_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"ip","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/dynamic_pools/{pool_name}/{ip}","href":"dynamic-ip-pools/post-v3-dynamic-pools--pool-name---ip-","openApiOperationId":"POST-v3-dynamic-pools--pool-name---ip-","summary":"Add IP to Dynamic IP Pool"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1dynamic_pools~1{pool_name}~1{ip}/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1dynamic_pools~1{pool_name}~1{ip}/post/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1dynamic_pools~1{pool_name}~1{ip}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1dynamic_pools~1{pool_name}~1{ip}/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1dynamic_pools~1{pool_name}~1{ip}/post/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dynamic-ip-pools/post-v3-dynamic-pools--pool-name---ip-"}],"panels":[]}]},"httpPath":"/v3/dynamic_pools/{pool_name}/{ip}"},{"label":"Update pool IPs","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/patch-v3-dynamic-pools--pool-name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/patch-v3-dynamic-pools--pool-name-","metadata":{"seo":{"title":"Update pool IPs","description":"Adds and/or removes IPs to/from the specified dynamic IP pool. A given pool is required to have at least 1 IP that is not actively warming. Additionally, a single IP cannot be assigned to multiple dynamic pools."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PATCH-v3-dynamic-pools--pool-name-","name":"Update pool IPs","isWebhook":false,"pointer":"/paths/~1v3~1dynamic_pools~1{pool_name}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update pool IPs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds and/or removes IPs to/from the specified dynamic IP pool.\nA given pool is required to have at least 1 IP that is not\nactively warming. Additionally, a single IP cannot be assigned to\nmultiple dynamic pools."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pool_name","in":"path","schemaId":"components/schemas/string","description":"The name of the dynamic IP pool","required":true}],"pointer":"/paths/~1v3~1dynamic_pools~1{pool_name}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PATCH-v3-dynamic_pools-pool_name-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/PATCH-v3-dynamic_pools-pool_name-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1dynamic_pools~1{pool_name}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v3/dynamic_pools/{pool_name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"pool_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/PATCH-v3-dynamic_pools-pool_name-multipart-form-data-RequestBody"}},"responseCodes":["200"],"pointer":"/v3/dynamic_pools/{pool_name}","href":"dynamic-ip-pools/patch-v3-dynamic-pools--pool-name-","openApiOperationId":"PATCH-v3-dynamic-pools--pool-name-","summary":"Update pool IPs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/PATCH-v3-dynamic_pools-pool_name-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PATCH-v3-dynamic_pools-pool_name-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1dynamic_pools~1{pool_name}/patch/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1dynamic_pools~1{pool_name}/patch/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1dynamic_pools~1{pool_name}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1dynamic_pools~1{pool_name}/patch/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1dynamic_pools~1{pool_name}/patch/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dynamic-ip-pools/patch-v3-dynamic-pools--pool-name-"}],"panels":[]}]},"httpPath":"/v3/dynamic_pools/{pool_name}"},{"label":"List all domains assigned to dynamic IP pools","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/get-v1-dynamic-pools-domains","routeSlug":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/get-v1-dynamic-pools-domains","metadata":{"seo":{"title":"List all domains assigned to dynamic IP pools","description":"Retrieves all domains enrolled in dynamic IP pools across the parent account and subaccounts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-dynamic-pools-domains","name":"List all domains assigned to dynamic IP pools","isWebhook":false,"pointer":"/paths/~1v1~1dynamic_pools~1domains/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all domains assigned to dynamic IP pools","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves all domains enrolled in dynamic IP pools across the parent account and subaccounts."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_295","description":"The maximum number of domains to return"},{"name":"account","in":"query","schemaId":"components/schemas/string","description":"Filter domains by account ID. Can be specified multiple times."},{"name":"pool","in":"query","schemaId":"components/schemas/string","description":"Filter domains to a specific Dynamic IP Pool. Can be specified multiple times."},{"name":"sort_by","in":"query","schemaId":"schema_296","description":"Specify which field to use to sort domains"},{"name":"sort_order","in":"query","schemaId":"schema_297","description":"Specify which field to use to sort domains"}],"pointer":"/paths/~1v1~1dynamic_pools~1domains/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/dynamic_pools/domains","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_295"},{"name":"account","in":"query","schemaId":"components/schemas/string"},{"name":"pool","in":"query","schemaId":"components/schemas/string"},{"name":"sort_by","in":"query","schemaId":"schema_296"},{"name":"sort_order","in":"query","schemaId":"schema_297"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/dynamic_pools/domains","href":"dynamic-ip-pools/get-v1-dynamic-pools-domains","openApiOperationId":"GET-v1-dynamic-pools-domains","summary":"List all domains assigned to dynamic IP pools"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-bandersnatch-api-DomainListResponse","exampleIds":["paths/~1v1~1dynamic_pools~1domains/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-bandersnatch-api-DomainListResponse","exampleIds":["paths/~1v1~1dynamic_pools~1domains/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dynamic_pools~1domains/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dynamic_pools~1domains/get/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1dynamic_pools~1domains/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-bandersnatch-api-DomainListResponse","exampleIds":["paths/~1v1~1dynamic_pools~1domains/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-bandersnatch-api-DomainListResponse","exampleIds":["paths/~1v1~1dynamic_pools~1domains/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dynamic_pools~1domains/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dynamic_pools~1domains/get/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dynamic-ip-pools/get-v1-dynamic-pools-domains"}],"panels":[]}]},"httpPath":"/v1/dynamic_pools/domains"},{"label":"Preview domain assignment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/get-v1-dynamic-pools-domains--name--preview","routeSlug":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/get-v1-dynamic-pools-domains--name--preview","metadata":{"seo":{"title":"Preview domain assignment","description":"Runs a health check on a domain and returns which pool it would be placed in. It does NOT enroll the domain or set the band"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-dynamic-pools-domains--name--preview","name":"Preview domain assignment","isWebhook":false,"pointer":"/paths/~1v1~1dynamic_pools~1domains~1{name}~1preview/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Preview domain assignment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Runs a health check on a domain and returns which pool it would be placed in. It does NOT enroll the domain or set the band"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"The domain name","required":true}],"pointer":"/paths/~1v1~1dynamic_pools~1domains~1{name}~1preview/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/dynamic_pools/domains/{name}/preview","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/dynamic_pools/domains/{name}/preview","href":"dynamic-ip-pools/get-v1-dynamic-pools-domains--name--preview","openApiOperationId":"GET-v1-dynamic-pools-domains--name--preview","summary":"Preview domain assignment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v1~1dynamic_pools~1domains~1{name}~1preview/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v1~1dynamic_pools~1domains~1{name}~1preview/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1dynamic_pools~1domains~1{name}~1preview/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v1~1dynamic_pools~1domains~1{name}~1preview/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v1~1dynamic_pools~1domains~1{name}~1preview/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dynamic-ip-pools/get-v1-dynamic-pools-domains--name--preview"}],"panels":[]}]},"httpPath":"/v1/dynamic_pools/domains/{name}/preview"},{"label":"List domain history","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/get-v1-dynamic-pools-domains--name--history","routeSlug":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/get-v1-dynamic-pools-domains--name--history","metadata":{"seo":{"title":"List domain history","description":"Retrieves a domain's history records"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-dynamic-pools-domains--name--history","name":"List domain history","isWebhook":false,"pointer":"/paths/~1v1~1dynamic_pools~1domains~1{name}~1history/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List domain history","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a domain's history records"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"The domain name","required":true}],"pointer":"/paths/~1v1~1dynamic_pools~1domains~1{name}~1history/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/dynamic_pools/domains/{name}/history","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/dynamic_pools/domains/{name}/history","href":"dynamic-ip-pools/get-v1-dynamic-pools-domains--name--history","openApiOperationId":"GET-v1-dynamic-pools-domains--name--history","summary":"List domain history"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-bandersnatch-model-HistoryRecord","exampleIds":["paths/~1v1~1dynamic_pools~1domains~1{name}~1history/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-bandersnatch-model-HistoryRecord","exampleIds":["paths/~1v1~1dynamic_pools~1domains~1{name}~1history/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1dynamic_pools~1domains~1{name}~1history/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-bandersnatch-model-HistoryRecord","exampleIds":["paths/~1v1~1dynamic_pools~1domains~1{name}~1history/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-bandersnatch-model-HistoryRecord","exampleIds":["paths/~1v1~1dynamic_pools~1domains~1{name}~1history/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dynamic-ip-pools/get-v1-dynamic-pools-domains--name--history"}],"panels":[]}]},"httpPath":"/v1/dynamic_pools/domains/{name}/history"},{"label":"Override domain assignment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/put-v1-dynamic-pools-domains--name--override","routeSlug":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/put-v1-dynamic-pools-domains--name--override","metadata":{"seo":{"title":"Override domain assignment","description":"Overrides a domain's dynamic IP pool assignment. A domain's pool will not be updated by health checks while an override is present."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v1-dynamic-pools-domains--name--override","name":"Override domain assignment","isWebhook":false,"pointer":"/paths/~1v1~1dynamic_pools~1domains~1{name}~1override/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Override domain assignment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Overrides a domain's dynamic IP pool assignment. A domain's pool will not be updated by health checks while an override is present."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"The domain name","required":true}],"pointer":"/paths/~1v1~1dynamic_pools~1domains~1{name}~1override/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v1-dynamic_pools-domains-name-override-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/PUT-v1-dynamic_pools-domains-name-override-multipart-form-data-RequestBody","pointer":"/paths/~1v1~1dynamic_pools~1domains~1{name}~1override/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/dynamic_pools/domains/{name}/override","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v1-dynamic_pools-domains-name-override-multipart-form-data-RequestBody"}},"responseCodes":["200","400"],"pointer":"/v1/dynamic_pools/domains/{name}/override","href":"dynamic-ip-pools/put-v1-dynamic-pools-domains--name--override","openApiOperationId":"PUT-v1-dynamic-pools-domains--name--override","summary":"Override domain assignment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/PUT-v1-dynamic_pools-domains-name-override-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v1-dynamic_pools-domains-name-override-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v1~1dynamic_pools~1domains~1{name}~1override/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v1~1dynamic_pools~1domains~1{name}~1override/put/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-InvalidParameterError","exampleIds":["paths/~1v1~1dynamic_pools~1domains~1{name}~1override/put/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-InvalidParameterError","exampleIds":["paths/~1v1~1dynamic_pools~1domains~1{name}~1override/put/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1dynamic_pools~1domains~1{name}~1override/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v1~1dynamic_pools~1domains~1{name}~1override/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v1~1dynamic_pools~1domains~1{name}~1override/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-InvalidParameterError","exampleIds":["paths/~1v1~1dynamic_pools~1domains~1{name}~1override/put/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-InvalidParameterError","exampleIds":["paths/~1v1~1dynamic_pools~1domains~1{name}~1override/put/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dynamic-ip-pools/put-v1-dynamic-pools-domains--name--override"}],"panels":[]}]},"httpPath":"/v1/dynamic_pools/domains/{name}/override"},{"label":"Remove override","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/delete-v1-dynamic-pools-domains--name--override","routeSlug":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/delete-v1-dynamic-pools-domains--name--override","metadata":{"seo":{"title":"Remove override","description":"Removes any dynamic IP pool override for a domain. The domain's pool assignment will be managed by health checks."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v1-dynamic-pools-domains--name--override","name":"Remove override","isWebhook":false,"pointer":"/paths/~1v1~1dynamic_pools~1domains~1{name}~1override/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove override","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes any dynamic IP pool override for a domain. The domain's pool assignment will be managed by health checks."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"The domain name","required":true}],"pointer":"/paths/~1v1~1dynamic_pools~1domains~1{name}~1override/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/dynamic_pools/domains/{name}/override","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/dynamic_pools/domains/{name}/override","href":"dynamic-ip-pools/delete-v1-dynamic-pools-domains--name--override","openApiOperationId":"DELETE-v1-dynamic-pools-domains--name--override","summary":"Remove override"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v1~1dynamic_pools~1domains~1{name}~1override/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v1~1dynamic_pools~1domains~1{name}~1override/delete/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1dynamic_pools~1domains~1{name}~1override/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v1~1dynamic_pools~1domains~1{name}~1override/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v1~1dynamic_pools~1domains~1{name}~1override/delete/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dynamic-ip-pools/delete-v1-dynamic-pools-domains--name--override"}],"panels":[]}]},"httpPath":"/v1/dynamic_pools/domains/{name}/override"},{"label":"List account history","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/get-v1-dynamic-pools-history","routeSlug":"/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/get-v1-dynamic-pools-history","metadata":{"seo":{"title":"List account history","description":"Retrieve history records for all domains assigned to Dynamic IP Pools across the parent and subaccounts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-dynamic-pools-history","name":"List account history","isWebhook":false,"pointer":"/paths/~1v1~1dynamic_pools~1history/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List account history","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve history records for all domains assigned to Dynamic IP Pools across the parent and subaccounts."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"Limit","in":"query","schemaId":"schema_295","description":"The maximum number of events to return"},{"name":"include_subaccounts","in":"query","schemaId":"schema_261","description":"If true, includes events from all subaccounts in addition to events from the parent account"},{"name":"domain","in":"query","schemaId":"components/schemas/string","description":"Filter events by domain name"},{"name":"before","in":"query","schemaId":"components/schemas/string","description":"Filter events emitted before a given timestamp (Format: Mon, 02 Jan 2006 15:04:05 MST)"},{"name":"after","in":"query","schemaId":"components/schemas/string","description":"Filter events emitted after a given timestamp (Format: Mon, 02 Jan 2006 15:04:05 MST)"},{"name":"moved_to","in":"query","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter events by which Dynamic Pool a domain was moved to (ex. dynamic_good, dynamic_poor, etc.)"},"children":[]}]}]}]},{"name":"moved_from","in":"query","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter events by which Dynamic Pool a domain was moved from (ex. dynamic_good, dynamic_poor, etc.)"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1dynamic_pools~1history/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/dynamic_pools/history","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"Limit","in":"query","schemaId":"schema_295"},{"name":"include_subaccounts","in":"query","schemaId":"schema_261"},{"name":"domain","in":"query","schemaId":"components/schemas/string"},{"name":"before","in":"query","schemaId":"components/schemas/string"},{"name":"after","in":"query","schemaId":"components/schemas/string"},{"name":"moved_to","in":"query","schemaId":"components/schemas/string"},{"name":"moved_from","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/dynamic_pools/history","href":"dynamic-ip-pools/get-v1-dynamic-pools-history","openApiOperationId":"GET-v1-dynamic-pools-history","summary":"List account history"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-bandersnatch-api-ListHistoryResponse","exampleIds":["paths/~1v1~1dynamic_pools~1history/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-bandersnatch-api-ListHistoryResponse","exampleIds":["paths/~1v1~1dynamic_pools~1history/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dynamic_pools~1history/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dynamic_pools~1history/get/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1dynamic_pools~1history/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-bandersnatch-api-ListHistoryResponse","exampleIds":["paths/~1v1~1dynamic_pools~1history/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-bandersnatch-api-ListHistoryResponse","exampleIds":["paths/~1v1~1dynamic_pools~1history/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dynamic_pools~1history/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1dynamic_pools~1history/get/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dynamic-ip-pools/get-v1-dynamic-pools-history"}],"panels":[]}]},"httpPath":"/v1/dynamic_pools/history"}],"content":{"contentType":"group","meta":{"name":"Dynamic IP Pools"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Dynamic IP Pools","showPageActions":true},{"nodeType":"markdoc","content":"Dynamic IP Pools allow you to group your dedicated IPs into customized \"pools\" based on sender reputation. Domains enrolled in Dynamic IP Pools will be assigned to a pool based on the result of periodic health checks."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/domains/{name}/dynamic_pools","summary":"Enroll domain","prefix":{"name":"post","color":"post"},"badges":[],"link":"/dynamic-ip-pools/post-v3-domains--name--dynamic-pools","deprecated":false},{"title":"/v3/domains/{name}/dynamic_pools","summary":"Remove domain from dynamic IP pools","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/dynamic-ip-pools/delete-v3-domains--name--dynamic-pools","deprecated":false},{"title":"/v3/domains/dynamic_pools/assignable","summary":"List assignable domains","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dynamic-ip-pools/get-v3-domains-dynamic-pools-assignable","deprecated":false},{"title":"/v3/domains/all/dynamic_pools/enroll","summary":"Enroll all account domains","prefix":{"name":"post","color":"post"},"badges":[],"link":"/dynamic-ip-pools/post-v3-domains-all-dynamic-pools-enroll","deprecated":false},{"title":"/v3/dynamic_pools","summary":"List all Dynamic IP pools","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dynamic-ip-pools/get-v3-dynamic-pools","deprecated":false},{"title":"/v3/dynamic_pools/all","summary":"Initialize/set IPs for all pools","prefix":{"name":"post","color":"post"},"badges":[],"link":"/dynamic-ip-pools/post-v3-dynamic-pools-all","deprecated":false},{"title":"/v3/dynamic_pools/all","summary":"Remove all dynamic IP pools","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/dynamic-ip-pools/delete-v3-dynamic-pools-all","deprecated":false},{"title":"/v3/dynamic_pools/{pool_name}/{ip}","summary":"Add IP to Dynamic IP Pool","prefix":{"name":"post","color":"post"},"badges":[],"link":"/dynamic-ip-pools/post-v3-dynamic-pools--pool-name---ip-","deprecated":false},{"title":"/v3/dynamic_pools/{pool_name}","summary":"Update pool IPs","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/dynamic-ip-pools/patch-v3-dynamic-pools--pool-name-","deprecated":false},{"title":"/v1/dynamic_pools/domains","summary":"List all domains assigned to dynamic IP pools","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dynamic-ip-pools/get-v1-dynamic-pools-domains","deprecated":false},{"title":"/v1/dynamic_pools/domains/{name}/preview","summary":"Preview domain assignment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dynamic-ip-pools/get-v1-dynamic-pools-domains--name--preview","deprecated":false},{"title":"/v1/dynamic_pools/domains/{name}/history","summary":"List domain history","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dynamic-ip-pools/get-v1-dynamic-pools-domains--name--history","deprecated":false},{"title":"/v1/dynamic_pools/domains/{name}/override","summary":"Override domain assignment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/dynamic-ip-pools/put-v1-dynamic-pools-domains--name--override","deprecated":false},{"title":"/v1/dynamic_pools/domains/{name}/override","summary":"Remove override","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/dynamic-ip-pools/delete-v1-dynamic-pools-domains--name--override","deprecated":false},{"title":"/v1/dynamic_pools/history","summary":"List account history","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dynamic-ip-pools/get-v1-dynamic-pools-history","deprecated":false}]}]}]}]}},{"type":"separator","label":"IPs","content":null},{"type":"group","label":"IPs","link":"/docs/mailgun/api-reference/send/mailgun/ips","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ips","items":[{"label":"Get the dedicated IP pool used for spillover for a domain","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ips/get-v3-ips-domain--name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ips/get-v3-ips-domain--name-","metadata":{"seo":{"title":"Get the dedicated IP pool used for spillover for a domain","description":"This endpoint retrieves the DIPP spillover settings for a specific domain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-ips-domain--name-","name":"Get the dedicated IP pool used for spillover for a domain","isWebhook":false,"pointer":"/paths/~1v3~1ips~1domain~1{name}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the dedicated IP pool used for spillover for a domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint retrieves the DIPP spillover settings for a specific domain."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"Id of the domain to get DIPP spillover settings for","required":true}],"pointer":"/paths/~1v3~1ips~1domain~1{name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/ips/domain/{name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/ips/domain/{name}","href":"ips/get-v3-ips-domain--name-","openApiOperationId":"GET-v3-ips-domain--name-","summary":"Get the dedicated IP pool used for spillover for a domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-domain-dipp_spillover-DIPPSpilloverResponseDoc","exampleIds":["paths/~1v3~1ips~1domain~1{name}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-tower-api-domain-dipp_spillover-DIPPSpilloverResponseDoc","exampleIds":["paths/~1v3~1ips~1domain~1{name}/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1ips~1domain~1{name}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-tower-api-domain-dipp_spillover-DIPPSpilloverResponseDoc","exampleIds":["paths/~1v3~1ips~1domain~1{name}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-domain-dipp_spillover-DIPPSpilloverResponseDoc","exampleIds":["paths/~1v3~1ips~1domain~1{name}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ips/get-v3-ips-domain--name-"}],"panels":[]}]},"httpPath":"/v3/ips/domain/{name}"},{"label":"Set or modify the dediciated IP pool used for spillover for a domain","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ips/patch-v3-ips-domain--name-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ips/patch-v3-ips-domain--name-","metadata":{"seo":{"title":"Set or modify the dediciated IP pool used for spillover for a domain","description":"This endpoint allows you to set or update the DIPP spillover settings for a specific domain.You can specify the ID of the IP pool that spillover IPs are assigned to. The IP pool must contain at least one fully warmed IP address to be valild.To disable DIPP spillover, set the pool_id to an empty string (\"\")."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PATCH-v3-ips-domain--name-","name":"Set or modify the dediciated IP pool used for spillover for a domain","isWebhook":false,"pointer":"/paths/~1v3~1ips~1domain~1{name}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set or modify the dediciated IP pool used for spillover for a domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to set or update the DIPP spillover settings for a specific domain."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can specify the ID of the IP pool that spillover IPs are assigned to. The IP pool must contain at least one fully warmed IP address to be valild."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To disable DIPP spillover, set the pool_id to an empty string (\"\")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"components/schemas/string","description":"Id of the domain to update DIPP spillover settings for","required":true}],"pointer":"/paths/~1v3~1ips~1domain~1{name}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-domain-dipp_spillover-DIPPSpilloverSettingsRequest","exampleIds":["paths/~1v3~1ips~1domain~1{name}/patch/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-tower-api-domain-dipp_spillover-DIPPSpilloverSettingsRequest","exampleIds":["paths/~1v3~1ips~1domain~1{name}/patch/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v3~1ips~1domain~1{name}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v3/ips/domain/{name}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-domain-dipp_spillover-DIPPSpilloverSettingsRequest","exampleIds":["paths/~1v3~1ips~1domain~1{name}/patch/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["200","400"],"pointer":"/v3/ips/domain/{name}","href":"ips/patch-v3-ips-domain--name-","openApiOperationId":"PATCH-v3-ips-domain--name-","summary":"Set or modify the dediciated IP pool used for spillover for a domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-tower-api-domain-dipp_spillover-DIPPSpilloverSettingsRequest","exampleIds":["paths/~1v3~1ips~1domain~1{name}/patch/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-domain-dipp_spillover-DIPPSpilloverSettingsRequest","exampleIds":["paths/~1v3~1ips~1domain~1{name}/patch/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1domain~1{name}/patch/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1domain~1{name}/patch/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1ips~1domain~1{name}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1domain~1{name}/patch/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1domain~1{name}/patch/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ips/patch-v3-ips-domain--name-"}],"panels":[]}]},"httpPath":"/v3/ips/domain/{name}"},{"label":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ips/delete-v3-domains--name--ips--ip-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ips/delete-v3-domains--name--ips--ip-","metadata":{"seo":{"title":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool","description":"The behavior of the endpoint depends on the value of the ip parameter. It can beone of the following:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3-domains--name--ips--ip-","name":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{name}~1ips~1{ip}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The behavior of the endpoint depends on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. It can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one of the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a valid IP address: this IP address will be removed from the domain pool."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the entire domain pool will be removed. As far as the system is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"concerned, such domain will no longer exist."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ip_pool"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the DIPP which is currently linked to the domain will be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unlinked."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"ips/delete-v3-domains--name--ips--ip-/request/ip-pools/delete-v3-domains--name--ips--ip-/request/removing-an-ip","deepLinkHash":"/ips/delete-v3-domains--name--ips--ip-#ips/delete-v3-domains--name--ips--ip-/request/ip-pools/delete-v3-domains--name--ips--ip-/request/removing-an-ip"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removing An IP"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that it's impossible to alter domain IPs if a DIPP is linked to the domain."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the account is not eligible for shared IPs, additional rules apply:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"removing the last IP from the domain is not allowed;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if all of the remaining dedicated IPs are on warmup, an extra IP might be added to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the domain pool."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"ips/delete-v3-domains--name--ips--ip-/request/ip-pools/delete-v3-domains--name--ips--ip-/request/unlinking-the-dipp","deepLinkHash":"/ips/delete-v3-domains--name--ips--ip-#ips/delete-v3-domains--name--ips--ip-/request/ip-pools/delete-v3-domains--name--ips--ip-/request/unlinking-the-dipp"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlinking The DIPP"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account must have 'DIPPs' feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pool_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter must be specified, but not both."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the special value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shared"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used for the replacement IP, the account must be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eligible for shared IPs. In this case the system will assign a shared IP as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"replacement."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ip","in":"path","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One of the following: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ip_pool"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a valid IP address."},"children":[]}]}]}],"required":true},{"name":"name","in":"path","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain name. Converted to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Mailgun-Domain-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header by the middleware."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v3~1domains~1{name}~1ips~1{ip}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ip","in":"query","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replacement IP or special value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shared"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"pool_id","in":"query","schemaId":"components/schemas/string","description":"Replacement DIPP id."}],"pointer":"/paths/~1v3~1domains~1{name}~1ips~1{ip}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/domains/{name}/ips/{ip}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"ip","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"ip","in":"query","schemaId":"components/schemas/string"},{"name":"pool_id","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/domains/{name}/ips/{ip}","href":"ips/delete-v3-domains--name--ips--ip-","openApiOperationId":"DELETE-v3-domains--name--ips--ip-","summary":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1ips~1{ip}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1ips~1{ip}/delete/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{name}~1ips~1{ip}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1ips~1{ip}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1ips~1{ip}/delete/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ips/delete-v3-domains--name--ips--ip-"}],"panels":[]}]},"httpPath":"/v3/domains/{name}/ips/{ip}"},{"label":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ips/delete-v3-domains--name--pool--ip-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ips/delete-v3-domains--name--pool--ip-","metadata":{"seo":{"title":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool","description":"The behavior of the endpoint depends on the value of the ip parameter. It can beone of the following:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3-domains--name--pool--ip-","name":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{name}~1pool~1{ip}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The behavior of the endpoint depends on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. It can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one of the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a valid IP address: this IP address will be removed from the domain pool."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the entire domain pool will be removed. As far as the system is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"concerned, such domain will no longer exist."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ip_pool"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the DIPP which is currently linked to the domain will be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unlinked."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"ips/delete-v3-domains--name--pool--ip-/request/ip-pools/delete-v3-domains--name--pool--ip-/request/removing-an-ip","deepLinkHash":"/ips/delete-v3-domains--name--pool--ip-#ips/delete-v3-domains--name--pool--ip-/request/ip-pools/delete-v3-domains--name--pool--ip-/request/removing-an-ip"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removing An IP"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that it's impossible to alter domain IPs if a DIPP is linked to the domain."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the account is not eligible for shared IPs, additional rules apply:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"removing the last IP from the domain is not allowed;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if all of the remaining dedicated IPs are on warmup, an extra IP might be added to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the domain pool."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"ips/delete-v3-domains--name--pool--ip-/request/ip-pools/delete-v3-domains--name--pool--ip-/request/unlinking-the-dipp","deepLinkHash":"/ips/delete-v3-domains--name--pool--ip-#ips/delete-v3-domains--name--pool--ip-/request/ip-pools/delete-v3-domains--name--pool--ip-/request/unlinking-the-dipp"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlinking The DIPP"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account must have 'DIPPs' feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pool_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter must be specified, but not both."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the special value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shared"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used for the replacement IP, the account must be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eligible for shared IPs. In this case the system will assign a shared IP as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"replacement."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ip","in":"path","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One of the following: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ip_pool"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a valid IP address."},"children":[]}]}]}],"required":true},{"name":"name","in":"path","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain name. Converted to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Mailgun-Domain-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header by the middleware."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v3~1domains~1{name}~1pool~1{ip}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ip","in":"query","schemaId":"components/schemas/string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replacement IP or special value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shared"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"pool_id","in":"query","schemaId":"components/schemas/string","description":"Replacement DIPP id."}],"pointer":"/paths/~1v3~1domains~1{name}~1pool~1{ip}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/domains/{name}/pool/{ip}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"ip","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"ip","in":"query","schemaId":"components/schemas/string"},{"name":"pool_id","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/domains/{name}/pool/{ip}","href":"ips/delete-v3-domains--name--pool--ip-","openApiOperationId":"DELETE-v3-domains--name--pool--ip-","summary":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1pool~1{ip}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1pool~1{ip}/delete/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{name}~1pool~1{ip}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1pool~1{ip}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{name}~1pool~1{ip}/delete/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ips/delete-v3-domains--name--pool--ip-"}],"panels":[]}]},"httpPath":"/v3/domains/{name}/pool/{ip}"},{"label":"Get DIPP spillover settings for an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ips/get-v3-ips-account-settings","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ips/get-v3-ips-account-settings","metadata":{"seo":{"title":"Get DIPP spillover settings for an account","description":"This endpoint retrieves the DIPP spillover settings for a specific account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-ips-account-settings","name":"Get DIPP spillover settings for an account","isWebhook":false,"pointer":"/paths/~1v3~1ips~1account~1settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get DIPP spillover settings for an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint retrieves the DIPP spillover settings for a specific account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/ips/account/settings","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/ips/account/settings","href":"ips/get-v3-ips-account-settings","openApiOperationId":"GET-v3-ips-account-settings","summary":"Get DIPP spillover settings for an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-account-dipp_spillover-DIPPSpilloverResponseDoc","exampleIds":["paths/~1v3~1ips~1account~1settings/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-tower-api-account-dipp_spillover-DIPPSpilloverResponseDoc","exampleIds":["paths/~1v3~1ips~1account~1settings/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1ips~1account~1settings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-tower-api-account-dipp_spillover-DIPPSpilloverResponseDoc","exampleIds":["paths/~1v3~1ips~1account~1settings/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-account-dipp_spillover-DIPPSpilloverResponseDoc","exampleIds":["paths/~1v3~1ips~1account~1settings/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ips/get-v3-ips-account-settings"}],"panels":[]}]},"httpPath":"/v3/ips/account/settings"},{"label":"Set or Modify the dedicated IP pool used for IP spillover","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ips/patch-v3-ips-account-settings","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ips/patch-v3-ips-account-settings","metadata":{"seo":{"title":"Set or Modify the dedicated IP pool used for IP spillover","description":"This endpoint allows you to set or update the DIPP spillover settings for an account .You can specify the ID of the IP pool that spillover IPs are assigned to. The IP pool must contain at least one fully warmed IP address to be valid.To disable DIPP spillover, set the pool_id to an empty string (\"\")."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PATCH-v3-ips-account-settings","name":"Set or Modify the dedicated IP pool used for IP spillover","isWebhook":false,"pointer":"/paths/~1v3~1ips~1account~1settings/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set or Modify the dedicated IP pool used for IP spillover","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to set or update the DIPP spillover settings for an account ."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can specify the ID of the IP pool that spillover IPs are assigned to. The IP pool must contain at least one fully warmed IP address to be valid."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To disable DIPP spillover, set the pool_id to an empty string (\"\")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-account-dipp_spillover-DIPPSpilloverSettingsRequest","exampleIds":["paths/~1v3~1ips~1account~1settings/patch/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-tower-api-account-dipp_spillover-DIPPSpilloverSettingsRequest","exampleIds":["paths/~1v3~1ips~1account~1settings/patch/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v3~1ips~1account~1settings/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v3/ips/account/settings","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-account-dipp_spillover-DIPPSpilloverSettingsRequest","exampleIds":["paths/~1v3~1ips~1account~1settings/patch/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["200","400"],"pointer":"/v3/ips/account/settings","href":"ips/patch-v3-ips-account-settings","openApiOperationId":"PATCH-v3-ips-account-settings","summary":"Set or Modify the dedicated IP pool used for IP spillover"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-tower-api-account-dipp_spillover-DIPPSpilloverSettingsRequest","exampleIds":["paths/~1v3~1ips~1account~1settings/patch/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-account-dipp_spillover-DIPPSpilloverSettingsRequest","exampleIds":["paths/~1v3~1ips~1account~1settings/patch/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1account~1settings/patch/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1account~1settings/patch/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1ips~1account~1settings/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1account~1settings/patch/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1account~1settings/patch/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ips/patch-v3-ips-account-settings"}],"panels":[]}]},"httpPath":"/v3/ips/account/settings"},{"label":"List account IPs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ips/get-v3-ips","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ips/get-v3-ips","metadata":{"seo":{"title":"List account IPs","description":"assignable_to_pool in response lists which IPs can be assigned to DIPPs; thisfield is present only if the account has 'DIPPs' feature enabled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-ips","name":"List account IPs","isWebhook":false,"pointer":"/paths/~1v3~1ips/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List account IPs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assignable_to_pool"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in response lists which IPs can be assigned to DIPPs; this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field is present only if the account has 'DIPPs' feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains the number of items returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (this depends on the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filters applied)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dedicated","in":"query","schemaId":"schema_261","description":"Return only dedicated IPs"},{"name":"enabled","in":"query","schemaId":"schema_261","description":"Return only enabled IPs"}],"pointer":"/paths/~1v3~1ips/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/ips","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"dedicated","in":"query","schemaId":"schema_261"},{"name":"enabled","in":"query","schemaId":"schema_261"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/ips","href":"ips/get-v3-ips","openApiOperationId":"GET-v3-ips","summary":"List account IPs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-account-list_ips-docResponse","exampleIds":["paths/~1v3~1ips/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-tower-api-account-list_ips-docResponse","exampleIds":["paths/~1v3~1ips/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1ips/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-tower-api-account-list_ips-docResponse","exampleIds":["paths/~1v3~1ips/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-account-list_ips-docResponse","exampleIds":["paths/~1v3~1ips/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ips/get-v3-ips"}],"panels":[]}]},"httpPath":"/v3/ips"},{"label":"Get details about account IP","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ips/get-v3-ips--ip-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ips/get-v3-ips--ip-","metadata":{"seo":{"title":"Get details about account IP","description":"Get details about account IP"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-ips--ip-","name":"Get details about account IP","isWebhook":false,"pointer":"/paths/~1v3~1ips~1{ip}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get details about account IP","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ip","in":"path","schemaId":"components/schemas/string","description":"IP address to get details about","required":true}],"pointer":"/paths/~1v3~1ips~1{ip}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/ips/{ip}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"ip","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/ips/{ip}","href":"ips/get-v3-ips--ip-","openApiOperationId":"GET-v3-ips--ip-","summary":"Get details about account IP"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-account-getDocResponse","exampleIds":["paths/~1v3~1ips~1{ip}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-tower-api-account-getDocResponse","exampleIds":["paths/~1v3~1ips~1{ip}/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1ips~1{ip}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-tower-api-account-getDocResponse","exampleIds":["paths/~1v3~1ips~1{ip}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-account-getDocResponse","exampleIds":["paths/~1v3~1ips~1{ip}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ips/get-v3-ips--ip-"}],"panels":[]}]},"httpPath":"/v3/ips/{ip}"},{"label":"Get all domains of an account where a specific IP is assigned","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ips/get-v3-ips--ip--domains","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ips/get-v3-ips--ip--domains","metadata":{"seo":{"title":"Get all domains of an account where a specific IP is assigned","description":"The IP must belong to the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-ips--ip--domains","name":"Get all domains of an account where a specific IP is assigned","isWebhook":false,"pointer":"/paths/~1v3~1ips~1{ip}~1domains/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all domains of an account where a specific IP is assigned","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IP must belong to the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Matching domains are ordered by increasing id, then the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameters"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is present, it is used to limit the results to domains"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"whose names match the search query. The search query is split into words by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"whitespace and punctuation, then the logical OR is applied."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ip","in":"path","schemaId":"components/schemas/string","description":"The IP to filter on","required":true}],"pointer":"/paths/~1v3~1ips~1{ip}~1domains/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_260","description":"The limit to apply to the returned domains","required":true},{"name":"search","in":"query","schemaId":"components/schemas/string","description":"The search query that the returned domains' names must match","required":true},{"name":"skip","in":"query","schemaId":"schema_260","description":"The number of matching domains to skip in the response","required":true}],"pointer":"/paths/~1v3~1ips~1{ip}~1domains/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/ips/{ip}/domains","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"ip","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"limit","in":"query","required":true,"schemaId":"schema_260"},{"name":"search","in":"query","required":true,"schemaId":"components/schemas/string"},{"name":"skip","in":"query","required":true,"schemaId":"schema_260"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/ips/{ip}/domains","href":"ips/get-v3-ips--ip--domains","openApiOperationId":"GET-v3-ips--ip--domains","summary":"Get all domains of an account where a specific IP is assigned"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-account-domainsResponse","exampleIds":["paths/~1v3~1ips~1{ip}~1domains/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-tower-api-account-domainsResponse","exampleIds":["paths/~1v3~1ips~1{ip}~1domains/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1ips~1{ip}~1domains/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-tower-api-account-domainsResponse","exampleIds":["paths/~1v3~1ips~1{ip}~1domains/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-account-domainsResponse","exampleIds":["paths/~1v3~1ips~1{ip}~1domains/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ips/get-v3-ips--ip--domains"}],"panels":[]}]},"httpPath":"/v3/ips/{ip}/domains"},{"label":"Assign an IP to all account domains","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ips/post-v3-ips--ip--domains","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ips/post-v3-ips--ip--domains","metadata":{"seo":{"title":"Assign an IP to all account domains","description":"The IP must belong to the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3-ips--ip--domains","name":"Assign an IP to all account domains","isWebhook":false,"pointer":"/paths/~1v3~1ips~1{ip}~1domains/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assign an IP to all account domains","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The IP must belong to the account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ip","in":"path","schemaId":"components/schemas/string","description":"The IP to Add","required":true}],"pointer":"/paths/~1v3~1ips~1{ip}~1domains/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/ips/{ip}/domains","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"ip","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/ips/{ip}/domains","href":"ips/post-v3-ips--ip--domains","openApiOperationId":"POST-v3-ips--ip--domains","summary":"Assign an IP to all account domains"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-StartSagaResponse","exampleIds":["paths/~1v3~1ips~1{ip}~1domains/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-tower-api-StartSagaResponse","exampleIds":["paths/~1v3~1ips~1{ip}~1domains/post/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1ips~1{ip}~1domains/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-tower-api-StartSagaResponse","exampleIds":["paths/~1v3~1ips~1{ip}~1domains/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-StartSagaResponse","exampleIds":["paths/~1v3~1ips~1{ip}~1domains/post/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ips/post-v3-ips--ip--domains"}],"panels":[]}]},"httpPath":"/v3/ips/{ip}/domains"},{"label":"Remove an IP from all account domains","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ips/delete-v3-ips--ip--domains","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ips/delete-v3-ips--ip--domains","metadata":{"seo":{"title":"Remove an IP from all account domains","description":"The IP must belong to the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3-ips--ip--domains","name":"Remove an IP from all account domains","isWebhook":false,"pointer":"/paths/~1v3~1ips~1{ip}~1domains/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove an IP from all account domains","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IP must belong to the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"alternative"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is present, it is used to replace the removed ip on all domains."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ip","in":"path","schemaId":"components/schemas/string","description":"The IP to Remove","required":true}],"pointer":"/paths/~1v3~1ips~1{ip}~1domains/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"alternative","in":"query","schemaId":"components/schemas/string","description":"An IP that will replace the removed IP on all domains","required":true}],"pointer":"/paths/~1v3~1ips~1{ip}~1domains/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/ips/{ip}/domains","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"ip","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"alternative","in":"query","required":true,"schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/ips/{ip}/domains","href":"ips/delete-v3-ips--ip--domains","openApiOperationId":"DELETE-v3-ips--ip--domains","summary":"Remove an IP from all account domains"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-StartSagaResponse","exampleIds":["paths/~1v3~1ips~1{ip}~1domains/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-tower-api-StartSagaResponse","exampleIds":["paths/~1v3~1ips~1{ip}~1domains/delete/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1ips~1{ip}~1domains/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-tower-api-StartSagaResponse","exampleIds":["paths/~1v3~1ips~1{ip}~1domains/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-StartSagaResponse","exampleIds":["paths/~1v3~1ips~1{ip}~1domains/delete/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ips/delete-v3-ips--ip--domains"}],"panels":[]}]},"httpPath":"/v3/ips/{ip}/domains"},{"label":"Place account IP into a dedicated IP band","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ips/post-v3-ips--addr--ip-band","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ips/post-v3-ips--addr--ip-band","metadata":{"seo":{"title":"Place account IP into a dedicated IP band","description":"The Dedicated IP Bands feature must be enabled for the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3-ips--addr--ip-band","name":"Place account IP into a dedicated IP band","isWebhook":false,"pointer":"/paths/~1v3~1ips~1{addr}~1ip_band/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Place account IP into a dedicated IP band","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dedicated IP Bands"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature must be enabled for the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IP must be a dedicated one belonging to the account."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"addr","in":"path","schemaId":"components/schemas/string","description":"IP address","required":true}],"pointer":"/paths/~1v3~1ips~1{addr}~1ip_band/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-ips-addr-ip_band-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/POST-v3-ips-addr-ip_band-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1ips~1{addr}~1ip_band/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/ips/{addr}/ip_band","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"addr","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-ips-addr-ip_band-multipart-form-data-RequestBody"}},"responseCodes":["200","400","403","404","409"],"pointer":"/v3/ips/{addr}/ip_band","href":"ips/post-v3-ips--addr--ip-band","openApiOperationId":"POST-v3-ips--addr--ip-band","summary":"Place account IP into a dedicated IP band"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/POST-v3-ips-addr-ip_band-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-ips-addr-ip_band-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1{addr}~1ip_band/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1{addr}~1ip_band/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1{addr}~1ip_band/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1{addr}~1ip_band/post/responses/400/content/application~1json/examples/Example"]},{"code":"403","description":"A 403 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1{addr}~1ip_band/post/responses/403/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1{addr}~1ip_band/post/responses/403/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1{addr}~1ip_band/post/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1{addr}~1ip_band/post/responses/404/content/application~1json/examples/Example"]},{"code":"409","description":"A 409 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1{addr}~1ip_band/post/responses/409/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1{addr}~1ip_band/post/responses/409/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1ips~1{addr}~1ip_band/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1{addr}~1ip_band/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1{addr}~1ip_band/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1{addr}~1ip_band/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1{addr}~1ip_band/post/responses/400/content/application~1json/examples/Example"]}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1{addr}~1ip_band/post/responses/403/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1{addr}~1ip_band/post/responses/403/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1{addr}~1ip_band/post/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1{addr}~1ip_band/post/responses/404/content/application~1json/examples/Example"]}}},{"code":"409","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1{addr}~1ip_band/post/responses/409/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1{addr}~1ip_band/post/responses/409/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ips/post-v3-ips--addr--ip-band"}],"panels":[]}]},"httpPath":"/v3/ips/{addr}/ip_band"},{"label":"Return the number of IPs available to the account per its billing plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ips/get-v3-ips-request-new","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ips/get-v3-ips-request-new","metadata":{"seo":{"title":"Return the number of IPs available to the account per its billing plan","description":"This endpoint remains active for backwards compatibility. Do not use it in new code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-ips-request-new","name":"Return the number of IPs available to the account per its billing plan","isWebhook":false,"pointer":"/paths/~1v3~1ips~1request~1new/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return the number of IPs available to the account per its billing plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint remains active for backwards compatibility. Do not use it in new code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shared"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response is deprecated and should not be used."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/ips/request/new","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/ips/request/new","href":"ips/get-v3-ips-request-new","openApiOperationId":"GET-v3-ips-request-new","summary":"Return the number of IPs available to the account per its billing plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ips~1request~1new/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ips~1request~1new/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1ips~1request~1new/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ips~1request~1new/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ips~1request~1new/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ips/get-v3-ips-request-new"}],"panels":[]}]},"httpPath":"/v3/ips/request/new"},{"label":"Add a new dedicated IP to the account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ips/post-v3-ips-request-new","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ips/post-v3-ips-request-new","metadata":{"seo":{"title":"Add a new dedicated IP to the account","description":"A new IP can be assigned only if billing limits allow that."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3-ips-request-new","name":"Add a new dedicated IP to the account","isWebhook":false,"pointer":"/paths/~1v3~1ips~1request~1new/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a new dedicated IP to the account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"A new IP can be assigned only if billing limits allow that."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/ips/request/new","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/ips/request/new","href":"ips/post-v3-ips-request-new","openApiOperationId":"POST-v3-ips-request-new","summary":"Add a new dedicated IP to the account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ips~1request~1new/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ips~1request~1new/post/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1ips~1request~1new/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ips~1request~1new/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/string","exampleIds":["paths/~1v3~1ips~1request~1new/post/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ips/post-v3-ips-request-new"}],"panels":[]}]},"httpPath":"/v3/ips/request/new"},{"label":"List account IPs - detailed view","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ips/get-v3-ips-details-all","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ips/get-v3-ips-details-all","metadata":{"seo":{"title":"List account IPs - detailed view","description":"List IPs belonging to the account and subaccounts. For IPs linked to subaccounts, there will be an additional record returned per subaccount The detailed IP view feature must be enabled for the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-ips-details-all","name":"List account IPs - detailed view","isWebhook":false,"pointer":"/paths/~1v3~1ips~1details~1all/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List account IPs - detailed view","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List IPs belonging to the account and subaccounts. For IPs linked to subaccounts, there will be an additional record returned per subaccount\nThe detailed IP view feature must be enabled for the account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_298","description":"Maximum records to return"},{"name":"skip","in":"query","schemaId":"schema_299","description":"The amount of returned records to skip"},{"name":"pool_id","in":"query","schemaId":"components/schemas/string","description":"Filter IPs linked to a pool. Value can be a specific pool ID, 'any' or 'none'"},{"name":"domain_id","in":"query","schemaId":"components/schemas/string","description":"Filter IPs linked to a domain. Value can be a specific domain ID, 'any' or 'none'"},{"name":"subaccount_id","in":"query","schemaId":"components/schemas/string","description":"Filter IPs linked to a subaccount. Value can be a specific subaccount ID, 'any' or 'none'"},{"name":"ip","in":"query","schemaId":"components/schemas/string","description":"Search for IPs containing this text (supports partial matching)"},{"name":"sort_by","in":"query","schemaId":"components/schemas/string","description":"Name of the field to sort results by"},{"name":"sort_order","in":"query","schemaId":"schema_300","description":"Sort results 'descending' or 'ascending'"}],"pointer":"/paths/~1v3~1ips~1details~1all/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/ips/details/all","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_298"},{"name":"skip","in":"query","schemaId":"schema_299"},{"name":"pool_id","in":"query","schemaId":"components/schemas/string"},{"name":"domain_id","in":"query","schemaId":"components/schemas/string"},{"name":"subaccount_id","in":"query","schemaId":"components/schemas/string"},{"name":"ip","in":"query","schemaId":"components/schemas/string"},{"name":"sort_by","in":"query","schemaId":"components/schemas/string"},{"name":"sort_order","in":"query","schemaId":"schema_300"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","403"],"pointer":"/v3/ips/details/all","href":"ips/get-v3-ips-details-all","openApiOperationId":"GET-v3-ips-details-all","summary":"List account IPs - detailed view"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-account-list_ips-DetailedIPsResponseDoc","exampleIds":["paths/~1v3~1ips~1details~1all/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-tower-api-account-list_ips-DetailedIPsResponseDoc","exampleIds":["paths/~1v3~1ips~1details~1all/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"403","description":"A 403 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v3~1ips~1details~1all/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-tower-api-account-list_ips-DetailedIPsResponseDoc","exampleIds":["paths/~1v3~1ips~1details~1all/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-tower-api-account-list_ips-DetailedIPsResponseDoc","exampleIds":["paths/~1v3~1ips~1details~1all/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ips/get-v3-ips-details-all"}],"panels":[]}]},"httpPath":"/v3/ips/details/all"},{"label":"Update subaccount IP assignments","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ips/patch-v3-ips-subaccounts","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ips/patch-v3-ips-subaccounts","metadata":{"seo":{"title":"Update subaccount IP assignments","description":"Description"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PATCH-v3-ips-subaccounts","name":"Update subaccount IP assignments","isWebhook":false,"pointer":"/paths/~1v3~1ips~1subaccounts/patch","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update subaccount IP assignments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"ips/patch-v3-ips-subaccounts/request/description","deepLinkHash":"/ips/patch-v3-ips-subaccounts#ips/patch-v3-ips-subaccounts/request/description"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Links and/or unlinks dedicated IPs to/from one or more subaccounts in a single operation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IPs linked to subaccounts can be linked to subaccount domains and placed in subaccount IP pools."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account must have the centralized IP assignment feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either subaccount_id (one or more) or all_subaccounts=true must be specified, but not both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When all_subaccounts=true or over 100 subaccounts are specified, the operation is applied to every subaccount asynchronously"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the response will contain 'queued' instead of 'success'."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rules for linking an IP:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IP must be a dedicated IP belonging to the parent account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IP must not be assigned to a Dynamic IP Pool on the parent account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rules for unlinking an IP:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IP must not be assigned to any IP pools on the subaccount."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IP must not be assigned to any domains on the subaccount."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"ips/patch-v3-ips-subaccounts/request/request-schema","deepLinkHash":"/ips/patch-v3-ips-subaccounts#ips/patch-v3-ips-subaccounts/request/request-schema"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request Schema"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request parameters are encoded as form data."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subaccount_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Id of a subaccount to update (may be specified multiple times). Required unless all_subaccounts is true."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all_subaccounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, applies the operation to all subaccounts of the parent account asynchronously. Cannot be combined with subaccount_id."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"link_ip"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dedicated IP address to link to the subaccount (may be specified multiple times)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unlink_ip"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dedicated IP address to unlink from the subaccount (may be specified multiple times)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v3/ips/subaccounts","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","403","404"],"pointer":"/v3/ips/subaccounts","href":"ips/patch-v3-ips-subaccounts","openApiOperationId":"PATCH-v3-ips-subaccounts","summary":"Update subaccount IP assignments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1subaccounts/patch/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1subaccounts/patch/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1subaccounts/patch/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1subaccounts/patch/responses/400/content/application~1json/examples/Example"]},{"code":"403","description":"A 403 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1subaccounts/patch/responses/403/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1subaccounts/patch/responses/403/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1subaccounts/patch/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1subaccounts/patch/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1ips~1subaccounts/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1subaccounts/patch/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1subaccounts/patch/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1subaccounts/patch/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1subaccounts/patch/responses/400/content/application~1json/examples/Example"]}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1subaccounts/patch/responses/403/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1subaccounts/patch/responses/403/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1subaccounts/patch/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ips~1subaccounts/patch/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ips/patch-v3-ips-subaccounts"}],"panels":[]}]},"httpPath":"/v3/ips/subaccounts"}],"content":{"contentType":"group","meta":{"name":"IPs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"IPs","showPageActions":true},{"nodeType":"markdoc","content":"The IP API endpoint allows you to access information regarding the IPs allocated to your Mailgun account that are used for outbound sending."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/ips/domain/{name}","summary":"Get the dedicated IP pool used for spillover for a domain","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ips/get-v3-ips-domain--name-","deprecated":false},{"title":"/v3/ips/domain/{name}","summary":"Set or modify the dediciated IP pool used for spillover for a domain","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/ips/patch-v3-ips-domain--name-","deprecated":false},{"title":"/v3/domains/{name}/ips/{ip}","summary":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/ips/delete-v3-domains--name--ips--ip-","deprecated":false},{"title":"/v3/domains/{name}/pool/{ip}","summary":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/ips/delete-v3-domains--name--pool--ip-","deprecated":false},{"title":"/v3/ips/account/settings","summary":"Get DIPP spillover settings for an account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ips/get-v3-ips-account-settings","deprecated":false},{"title":"/v3/ips/account/settings","summary":"Set or Modify the dedicated IP pool used for IP spillover","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/ips/patch-v3-ips-account-settings","deprecated":false},{"title":"/v3/ips","summary":"List account IPs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ips/get-v3-ips","deprecated":false},{"title":"/v3/ips/{ip}","summary":"Get details about account IP","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ips/get-v3-ips--ip-","deprecated":false},{"title":"/v3/ips/{ip}/domains","summary":"Get all domains of an account where a specific IP is assigned","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ips/get-v3-ips--ip--domains","deprecated":false},{"title":"/v3/ips/{ip}/domains","summary":"Assign an IP to all account domains","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ips/post-v3-ips--ip--domains","deprecated":false},{"title":"/v3/ips/{ip}/domains","summary":"Remove an IP from all account domains","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/ips/delete-v3-ips--ip--domains","deprecated":false},{"title":"/v3/ips/{addr}/ip_band","summary":"Place account IP into a dedicated IP band","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ips/post-v3-ips--addr--ip-band","deprecated":false},{"title":"/v3/ips/request/new","summary":"Return the number of IPs available to the account per its billing plan","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ips/get-v3-ips-request-new","deprecated":false},{"title":"/v3/ips/request/new","summary":"Add a new dedicated IP to the account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ips/post-v3-ips-request-new","deprecated":false},{"title":"/v3/ips/details/all","summary":"List account IPs - detailed view","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ips/get-v3-ips-details-all","deprecated":false},{"title":"/v3/ips/subaccounts","summary":"Update subaccount IP assignments","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/ips/patch-v3-ips-subaccounts","deprecated":false}]}]}]}]}},{"type":"group","label":"IP Address Warmup","link":"/docs/mailgun/api-reference/send/mailgun/ip-address-warmup","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ip-address-warmup","items":[{"label":"Retrieves the list of in-flight IP address warmup statuses.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ip-address-warmup/get-v3-ip-warmups","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ip-address-warmup/get-v3-ip-warmups","metadata":{"seo":{"title":"Retrieves the list of in-flight IP address warmup statuses.","description":"Retrieves a list of in-flight IP warmup statuses for dedicated IP addresses owned by the account. The response includes pagination URLs for navigating through the results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-ip-warmups","name":"Retrieves the list of in-flight IP address warmup statuses.","isWebhook":false,"pointer":"/paths/~1v3~1ip_warmups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves the list of in-flight IP address warmup statuses.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of in-flight IP warmup statuses for dedicated IP addresses owned by the account. The response includes pagination URLs for navigating through the results."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"components/schemas/string","description":"The page to retrieve. If not specified, the first page is returned."},{"name":"limit","in":"query","schemaId":"components/schemas/string","description":"The number of results to return per page. Defaults to 10 if not specified."}],"pointer":"/paths/~1v3~1ip_warmups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/ip_warmups","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"components/schemas/string"},{"name":"limit","in":"query","schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/ip_warmups","href":"ip-address-warmup/get-v3-ip-warmups","openApiOperationId":"GET-v3-ip-warmups","summary":"Retrieves the list of in-flight IP address warmup statuses."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ip_warmups/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ip_warmups/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1ip_warmups/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ip_warmups/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ip_warmups/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-address-warmup/get-v3-ip-warmups"}],"panels":[]}]},"httpPath":"/v3/ip_warmups"},{"label":"Retrieves the status of an in-flight IP warmup","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ip-address-warmup/get-v3-ip-warmups--addr-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ip-address-warmup/get-v3-ip-warmups--addr-","metadata":{"seo":{"title":"Retrieves the status of an in-flight IP warmup","description":"Retrieves the status of an in-flight IP warmup, which must be a dedicated IP owned by the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-ip-warmups--addr-","name":"Retrieves the status of an in-flight IP warmup","isWebhook":false,"pointer":"/paths/~1v3~1ip_warmups~1{addr}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves the status of an in-flight IP warmup","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the status of an in-flight IP warmup, which must be a dedicated IP owned by the account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"addr","in":"path","schemaId":"components/schemas/string","description":"The IP address to retrieve the warmup status for.","required":true}],"pointer":"/paths/~1v3~1ip_warmups~1{addr}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/ip_warmups/{addr}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"addr","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/ip_warmups/{addr}","href":"ip-address-warmup/get-v3-ip-warmups--addr-","openApiOperationId":"GET-v3-ip-warmups--addr-","summary":"Retrieves the status of an in-flight IP warmup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ip_warmups~1{addr}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ip_warmups~1{addr}/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1ip_warmups~1{addr}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ip_warmups~1{addr}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ip_warmups~1{addr}/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-address-warmup/get-v3-ip-warmups--addr-"}],"panels":[]}]},"httpPath":"/v3/ip_warmups/{addr}"},{"label":"Creates a warmup plan for an IP Address","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ip-address-warmup/post-v3-ip-warmups--addr-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ip-address-warmup/post-v3-ip-warmups--addr-","metadata":{"seo":{"title":"Creates a warmup plan for an IP Address","description":"Creates a new warmup plan for an IP address. The IP must be dedicated and owned by the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3-ip-warmups--addr-","name":"Creates a warmup plan for an IP Address","isWebhook":false,"pointer":"/paths/~1v3~1ip_warmups~1{addr}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a warmup plan for an IP Address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new warmup plan for an IP address. The IP must be dedicated and owned by the account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"addr","in":"path","schemaId":"components/schemas/string","description":"The IP address to create the warmup plan for.","required":true}],"pointer":"/paths/~1v3~1ip_warmups~1{addr}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/ip_warmups/{addr}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"addr","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/ip_warmups/{addr}","href":"ip-address-warmup/post-v3-ip-warmups--addr-","openApiOperationId":"POST-v3-ip-warmups--addr-","summary":"Creates a warmup plan for an IP Address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ip_warmups~1{addr}/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ip_warmups~1{addr}/post/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1ip_warmups~1{addr}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ip_warmups~1{addr}/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ip_warmups~1{addr}/post/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-address-warmup/post-v3-ip-warmups--addr-"}],"panels":[]}]},"httpPath":"/v3/ip_warmups/{addr}"},{"label":"Cancels the warmup plan for an IP address","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ip-address-warmup/delete-v3-ip-warmups--addr-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ip-address-warmup/delete-v3-ip-warmups--addr-","metadata":{"seo":{"title":"Cancels the warmup plan for an IP address","description":"Cancels the warmup plan for an IP address. The IP must be dedicated and owned by the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3-ip-warmups--addr-","name":"Cancels the warmup plan for an IP address","isWebhook":false,"pointer":"/paths/~1v3~1ip_warmups~1{addr}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancels the warmup plan for an IP address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels the warmup plan for an IP address. The IP must be dedicated and owned by the account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"addr","in":"path","schemaId":"components/schemas/string","description":"The IP address to cancel the warmup plan for.","required":true}],"pointer":"/paths/~1v3~1ip_warmups~1{addr}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/ip_warmups/{addr}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"addr","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/ip_warmups/{addr}","href":"ip-address-warmup/delete-v3-ip-warmups--addr-","openApiOperationId":"DELETE-v3-ip-warmups--addr-","summary":"Cancels the warmup plan for an IP address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ip_warmups~1{addr}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ip_warmups~1{addr}/delete/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1ip_warmups~1{addr}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ip_warmups~1{addr}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1ip_warmups~1{addr}/delete/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-address-warmup/delete-v3-ip-warmups--addr-"}],"panels":[]}]},"httpPath":"/v3/ip_warmups/{addr}"}],"content":{"contentType":"group","meta":{"name":"IP Address Warmup"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"IP Address Warmup","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/ip_warmups","summary":"Retrieves the list of in-flight IP address warmup statuses.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ip-address-warmup/get-v3-ip-warmups","deprecated":false},{"title":"/v3/ip_warmups/{addr}","summary":"Retrieves the status of an in-flight IP warmup","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ip-address-warmup/get-v3-ip-warmups--addr-","deprecated":false},{"title":"/v3/ip_warmups/{addr}","summary":"Creates a warmup plan for an IP Address","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ip-address-warmup/post-v3-ip-warmups--addr-","deprecated":false},{"title":"/v3/ip_warmups/{addr}","summary":"Cancels the warmup plan for an IP address","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/ip-address-warmup/delete-v3-ip-warmups--addr-","deprecated":false}]}]}]}]}},{"type":"separator","label":"Subaccounts","content":null},{"type":"group","label":"Subaccounts","link":"/docs/mailgun/api-reference/send/mailgun/subaccounts","routeSlug":"/docs/mailgun/api-reference/send/mailgun/subaccounts","items":[{"label":"Get a single subaccount","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/subaccounts/get-v5-accounts-subaccounts-subaccount_id","routeSlug":"/docs/mailgun/api-reference/send/mailgun/subaccounts/get-v5-accounts-subaccounts-subaccount_id","metadata":{"seo":{"title":"Get a single subaccount","description":"Fetch the details of a single subaccount"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-v5-accounts-subaccounts-subaccount_id","name":"Get a single subaccount","isWebhook":false,"pointer":"/paths/~1v5~1accounts~1subaccounts~1{subaccount_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a single subaccount","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch the details of a single subaccount"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subaccount_id","in":"path","schemaId":"components/schemas/string","description":"The ID of the subaccount","required":true}],"pointer":"/paths/~1v5~1accounts~1subaccounts~1{subaccount_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/accounts/subaccounts/{subaccount_id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"subaccount_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v5/accounts/subaccounts/{subaccount_id}","href":"subaccounts/get-v5-accounts-subaccounts-subaccount_id","openApiOperationId":"get-v5-accounts-subaccounts-subaccount_id","summary":"Get a single subaccount"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-SubaccountResponse","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-SubaccountResponse","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}/get/responses/200/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}/get/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}/get/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v5~1accounts~1subaccounts~1{subaccount_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-accounts-api-SubaccountResponse","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-SubaccountResponse","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}/get/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}/get/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subaccounts/get-v5-accounts-subaccounts-subaccount_id"}],"panels":[]}]},"httpPath":"/v5/accounts/subaccounts/{subaccount_id}"},{"label":"List all subaccounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/subaccounts/get-v5-accounts-subaccounts","routeSlug":"/docs/mailgun/api-reference/send/mailgun/subaccounts/get-v5-accounts-subaccounts","metadata":{"seo":{"title":"List all subaccounts","description":"Fetch all subaccounts"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-v5-accounts-subaccounts","name":"List all subaccounts","isWebhook":false,"pointer":"/paths/~1v5~1accounts~1subaccounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all subaccounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch all subaccounts"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_301","description":"Sort order"},{"name":"filter","in":"query","schemaId":"components/schemas/string","description":"Name of account to filter by"},{"name":"limit","in":"query","schemaId":"schema_302","description":"Number of subaccounts to return"},{"name":"skip","in":"query","schemaId":"schema_299","description":"Number of subaccounts to skip"},{"name":"enabled","in":"query","schemaId":"schema_261","description":"Indicate to include enabled subaccounts (true) or disabled accounts (false). Leave unspecified to allow for either, depending on other parameters provided."},{"name":"closed","in":"query","schemaId":"schema_261","description":"Indicate to include closed subaccounts (true) or exclude closed accounts (false). Leave unspecified to allow for either, depending on other parameters provided."}],"pointer":"/paths/~1v5~1accounts~1subaccounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/accounts/subaccounts","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"sort","in":"query","required":false,"schemaId":"schema_301"},{"name":"filter","in":"query","required":false,"schemaId":"components/schemas/string"},{"name":"limit","in":"query","required":false,"schemaId":"schema_302"},{"name":"skip","in":"query","required":false,"schemaId":"schema_299"},{"name":"enabled","in":"query","required":false,"schemaId":"schema_261"},{"name":"closed","in":"query","required":false,"schemaId":"schema_261"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/accounts/subaccounts","href":"subaccounts/get-v5-accounts-subaccounts","openApiOperationId":"get-v5-accounts-subaccounts","summary":"List all subaccounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-SubaccountListResponse","exampleIds":["paths/~1v5~1accounts~1subaccounts/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-SubaccountListResponse","exampleIds":["paths/~1v5~1accounts~1subaccounts/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v5~1accounts~1subaccounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-accounts-api-SubaccountListResponse","exampleIds":["paths/~1v5~1accounts~1subaccounts/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-SubaccountListResponse","exampleIds":["paths/~1v5~1accounts~1subaccounts/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subaccounts/get-v5-accounts-subaccounts"}],"panels":[]}]},"httpPath":"/v5/accounts/subaccounts"},{"label":"Create a subaccount","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/subaccounts/post-v5-accounts-subaccounts","routeSlug":"/docs/mailgun/api-reference/send/mailgun/subaccounts/post-v5-accounts-subaccounts","metadata":{"seo":{"title":"Create a subaccount","description":"Create a subaccount"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-v5-accounts-subaccounts","name":"Create a subaccount","isWebhook":false,"pointer":"/paths/~1v5~1accounts~1subaccounts/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a subaccount","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a subaccount"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","schemaId":"components/schemas/string","description":"The name of the subaccount","required":true}],"pointer":"/paths/~1v5~1accounts~1subaccounts/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v5/accounts/subaccounts","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"name","in":"query","required":true,"schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v5/accounts/subaccounts","href":"subaccounts/post-v5-accounts-subaccounts","openApiOperationId":"post-v5-accounts-subaccounts","summary":"Create a subaccount"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully created a subaccount","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-SubaccountResponse","exampleIds":["paths/~1v5~1accounts~1subaccounts/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-SubaccountResponse","exampleIds":["paths/~1v5~1accounts~1subaccounts/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts/post/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v5~1accounts~1subaccounts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-accounts-api-SubaccountResponse","exampleIds":["paths/~1v5~1accounts~1subaccounts/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-SubaccountResponse","exampleIds":["paths/~1v5~1accounts~1subaccounts/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts/post/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subaccounts/post-v5-accounts-subaccounts"}],"panels":[]}]},"httpPath":"/v5/accounts/subaccounts"},{"label":"Delete a subaccount","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/subaccounts/delete-v5-accounts-subaccounts-subaccount_id","routeSlug":"/docs/mailgun/api-reference/send/mailgun/subaccounts/delete-v5-accounts-subaccounts-subaccount_id","metadata":{"seo":{"title":"Delete a subaccount","description":"Delete a subaccount"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-v5-accounts-subaccounts-subaccount_id","name":"Delete a subaccount","isWebhook":false,"pointer":"/paths/~1v5~1accounts~1subaccounts/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a subaccount","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a subaccount"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Mailgun-On-Behalf-Of","in":"header","schemaId":"components/schemas/string","description":"The ID of the subaccount","required":true}],"pointer":"/paths/~1v5~1accounts~1subaccounts/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v5/accounts/subaccounts","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Mailgun-On-Behalf-Of","in":"header","required":true,"schemaId":"components/schemas/string"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","403"],"pointer":"/v5/accounts/subaccounts","href":"subaccounts/delete-v5-accounts-subaccounts-subaccount_id","openApiOperationId":"delete-v5-accounts-subaccounts-subaccount_id","summary":"Delete a subaccount"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts/delete/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts/delete/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts/delete/responses/400/content/application~1json/examples/Example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts/delete/responses/403/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts/delete/responses/403/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v5~1accounts~1subaccounts/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts/delete/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts/delete/responses/400/content/application~1json/examples/Example"]}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts/delete/responses/403/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts/delete/responses/403/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subaccounts/delete-v5-accounts-subaccounts-subaccount_id"}],"panels":[]}]},"httpPath":"/v5/accounts/subaccounts"},{"label":"Disable a subaccount","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/subaccounts/post-v5-accounts-subaccounts-subaccount_id-disable","routeSlug":"/docs/mailgun/api-reference/send/mailgun/subaccounts/post-v5-accounts-subaccounts-subaccount_id-disable","metadata":{"seo":{"title":"Disable a subaccount","description":"Disable a subaccount"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-v5-accounts-subaccounts-subaccount_id-disable","name":"Disable a subaccount","isWebhook":false,"pointer":"/paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1disable/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Disable a subaccount","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Disable a subaccount"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subaccount_id","in":"path","schemaId":"components/schemas/string","description":"The ID of the subaccount","required":true}],"pointer":"/paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1disable/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"reason","in":"query","schemaId":"components/schemas/string","description":"The reason for disabling the subaccount"},{"name":"note","in":"query","schemaId":"components/schemas/string","description":"A note for the subaccount"}],"pointer":"/paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1disable/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v5/accounts/subaccounts/{subaccount_id}/disable","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"subaccount_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"reason","in":"query","required":false,"schemaId":"components/schemas/string"},{"name":"note","in":"query","required":false,"schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/v5/accounts/subaccounts/{subaccount_id}/disable","href":"subaccounts/post-v5-accounts-subaccounts-subaccount_id-disable","openApiOperationId":"post-v5-accounts-subaccounts-subaccount_id-disable","summary":"Disable a subaccount"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Subaccount disabled successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-SubaccountResponse","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1disable/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-SubaccountResponse","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1disable/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"Subaccount is already disabled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1disable/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1disable/post/responses/400/content/application~1json/examples/Example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1disable/post/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1disable/post/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1disable/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-accounts-api-SubaccountResponse","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1disable/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-SubaccountResponse","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1disable/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1disable/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1disable/post/responses/400/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1disable/post/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1disable/post/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subaccounts/post-v5-accounts-subaccounts-subaccount_id-disable"}],"panels":[]}]},"httpPath":"/v5/accounts/subaccounts/{subaccount_id}/disable"},{"label":"Enable a subaccount","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/subaccounts/post-v5-accounts-subaccounts-subaccount_id-enable","routeSlug":"/docs/mailgun/api-reference/send/mailgun/subaccounts/post-v5-accounts-subaccounts-subaccount_id-enable","metadata":{"seo":{"title":"Enable a subaccount","description":"Enable a subaccount"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-v5-accounts-subaccounts-subaccount_id-enable","name":"Enable a subaccount","isWebhook":false,"pointer":"/paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1enable/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enable a subaccount","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Enable a subaccount"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subaccount_id","in":"path","schemaId":"components/schemas/string","description":"The ID of the subaccount","required":true}],"pointer":"/paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1enable/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v5/accounts/subaccounts/{subaccount_id}/enable","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"subaccount_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/v5/accounts/subaccounts/{subaccount_id}/enable","href":"subaccounts/post-v5-accounts-subaccounts-subaccount_id-enable","openApiOperationId":"post-v5-accounts-subaccounts-subaccount_id-enable","summary":"Enable a subaccount"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Subaccount enabled successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-SubaccountResponse","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1enable/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-SubaccountResponse","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1enable/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"Cannot enable due to limit reached","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1enable/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1enable/post/responses/400/content/application~1json/examples/Example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1enable/post/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1enable/post/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1enable/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-accounts-api-SubaccountResponse","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1enable/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-SubaccountResponse","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1enable/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1enable/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1enable/post/responses/400/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1enable/post/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1enable/post/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subaccounts/post-v5-accounts-subaccounts-subaccount_id-enable"}],"panels":[]}]},"httpPath":"/v5/accounts/subaccounts/{subaccount_id}/enable"},{"label":"Get current custom sending limit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/subaccounts/get-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly","routeSlug":"/docs/mailgun/api-reference/send/mailgun/subaccounts/get-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly","metadata":{"seo":{"title":"Get current custom sending limit","description":"Fetch the details of custom sending limit on the account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly","name":"Get current custom sending limit","isWebhook":false,"pointer":"/paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get current custom sending limit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch the details of custom sending limit on the account"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subaccount_id","in":"path","schemaId":"components/schemas/string","description":"The ID of the subaccount","required":true}],"pointer":"/paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/accounts/subaccounts/{subaccount_id}/limit/custom/monthly","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"subaccount_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","403","404"],"pointer":"/v5/accounts/subaccounts/{subaccount_id}/limit/custom/monthly","href":"subaccounts/get-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly","openApiOperationId":"get-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly","summary":"Get current custom sending limit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-CustomMessageLimitResponse","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-CustomMessageLimitResponse","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/responses/400/content/application~1json/examples/Example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/responses/403/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/responses/403/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-accounts-api-CustomMessageLimitResponse","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-CustomMessageLimitResponse","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/responses/400/content/application~1json/examples/Example"]}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/responses/403/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/responses/403/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subaccounts/get-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly"}],"panels":[]}]},"httpPath":"/v5/accounts/subaccounts/{subaccount_id}/limit/custom/monthly"},{"label":"Set a custom sending limit","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/subaccounts/put-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly","routeSlug":"/docs/mailgun/api-reference/send/mailgun/subaccounts/put-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly","metadata":{"seo":{"title":"Set a custom sending limit","description":"Set a custom sending limit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly","name":"Set a custom sending limit","isWebhook":false,"pointer":"/paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set a custom sending limit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Set a custom sending limit"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subaccount_id","in":"path","schemaId":"components/schemas/string","description":"The ID of the subaccount","required":true}],"pointer":"/paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_303","description":"The limit to set","required":true}],"pointer":"/paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v5/accounts/subaccounts/{subaccount_id}/limit/custom/monthly","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"subaccount_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"limit","in":"query","required":true,"schemaId":"schema_303"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v5/accounts/subaccounts/{subaccount_id}/limit/custom/monthly","href":"subaccounts/put-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly","openApiOperationId":"put-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly","summary":"Set a custom sending limit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully set the sending limit","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/put/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/put/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/put/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/put/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/put/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subaccounts/put-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly"}],"panels":[]}]},"httpPath":"/v5/accounts/subaccounts/{subaccount_id}/limit/custom/monthly"},{"label":"Delete a custom sending limit","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/subaccounts/delete-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly","routeSlug":"/docs/mailgun/api-reference/send/mailgun/subaccounts/delete-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly","metadata":{"seo":{"title":"Delete a custom sending limit","description":"Delete a custom sending limit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly","name":"Delete a custom sending limit","isWebhook":false,"pointer":"/paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a custom sending limit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a custom sending limit"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subaccount_id","in":"path","schemaId":"components/schemas/string","description":"The ID of the subaccount","required":true}],"pointer":"/paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v5/accounts/subaccounts/{subaccount_id}/limit/custom/monthly","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"subaccount_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v5/accounts/subaccounts/{subaccount_id}/limit/custom/monthly","href":"subaccounts/delete-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly","openApiOperationId":"delete-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly","summary":"Delete a custom sending limit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully deleted the sending limit","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/delete/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/delete/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/delete/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/delete/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/delete/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subaccounts/delete-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly"}],"panels":[]}]},"httpPath":"/v5/accounts/subaccounts/{subaccount_id}/limit/custom/monthly"},{"label":"Update subaccount feature","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/subaccounts/put-v5-accounts-subaccounts-subaccount_id-features","routeSlug":"/docs/mailgun/api-reference/send/mailgun/subaccounts/put-v5-accounts-subaccounts-subaccount_id-features","metadata":{"seo":{"title":"Update subaccount feature","description":"Update subaccount feature"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-v5-accounts-subaccounts-subaccount_id-features","name":"Update subaccount feature","isWebhook":false,"pointer":"/paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1features/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update subaccount feature","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update subaccount feature"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subaccount_id","in":"path","schemaId":"components/schemas/string","description":"The ID of the subaccount","required":true}],"pointer":"/paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1features/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_304"}},"schemaId":"schema_304","pointer":"/paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1features/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v5/accounts/subaccounts/{subaccount_id}/features","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"subaccount_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_304"}},"responseCodes":["200","400","404"],"pointer":"/v5/accounts/subaccounts/{subaccount_id}/features","href":"subaccounts/put-v5-accounts-subaccounts-subaccount_id-features","openApiOperationId":"put-v5-accounts-subaccounts-subaccount_id-features","summary":"Update subaccount feature"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"schema_304","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_304"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated subaccount features","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_305","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1features/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"schema_305","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1features/put/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1features/put/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1features/put/responses/400/content/application~1json/examples/Example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1features/put/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1features/put/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1features/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_305","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1features/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_305","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1features/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1features/put/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1features/put/responses/400/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1features/put/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1features/put/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subaccounts/put-v5-accounts-subaccounts-subaccount_id-features"}],"panels":[]}]},"httpPath":"/v5/accounts/subaccounts/{subaccount_id}/features"}],"content":{"contentType":"group","meta":{"name":"Subaccounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subaccounts","showPageActions":true},{"nodeType":"markdoc","content":"Mailgun supports the creation, modification, and deletion of subaccounts. A subaccount is a child account of a parent account. The parent account can have multiple subaccounts. The subaccounts are created and managed by the parent account."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v5/accounts/subaccounts/{subaccount_id}","summary":"Get a single subaccount","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subaccounts/get-v5-accounts-subaccounts-subaccount_id","deprecated":false},{"title":"/v5/accounts/subaccounts","summary":"List all subaccounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subaccounts/get-v5-accounts-subaccounts","deprecated":false},{"title":"/v5/accounts/subaccounts","summary":"Create a subaccount","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subaccounts/post-v5-accounts-subaccounts","deprecated":false},{"title":"/v5/accounts/subaccounts","summary":"Delete a subaccount","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/subaccounts/delete-v5-accounts-subaccounts-subaccount_id","deprecated":false},{"title":"/v5/accounts/subaccounts/{subaccount_id}/disable","summary":"Disable a subaccount","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subaccounts/post-v5-accounts-subaccounts-subaccount_id-disable","deprecated":false},{"title":"/v5/accounts/subaccounts/{subaccount_id}/enable","summary":"Enable a subaccount","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subaccounts/post-v5-accounts-subaccounts-subaccount_id-enable","deprecated":false},{"title":"/v5/accounts/subaccounts/{subaccount_id}/limit/custom/monthly","summary":"Get current custom sending limit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subaccounts/get-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly","deprecated":false},{"title":"/v5/accounts/subaccounts/{subaccount_id}/limit/custom/monthly","summary":"Set a custom sending limit","prefix":{"name":"put","color":"put"},"badges":[],"link":"/subaccounts/put-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly","deprecated":false},{"title":"/v5/accounts/subaccounts/{subaccount_id}/limit/custom/monthly","summary":"Delete a custom sending limit","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/subaccounts/delete-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly","deprecated":false},{"title":"/v5/accounts/subaccounts/{subaccount_id}/features","summary":"Update subaccount feature","prefix":{"name":"put","color":"put"},"badges":[],"link":"/subaccounts/put-v5-accounts-subaccounts-subaccount_id-features","deprecated":false}]}]}]}]}},{"type":"separator","label":"Custom Message Limit","content":null},{"type":"group","label":"Custom Message Limit","link":"/docs/mailgun/api-reference/send/mailgun/custom-message-limit","routeSlug":"/docs/mailgun/api-reference/send/mailgun/custom-message-limit","items":[{"label":"Get current custom sending limit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/custom-message-limit/get-v5-accounts-limit-custom-monthly","routeSlug":"/docs/mailgun/api-reference/send/mailgun/custom-message-limit/get-v5-accounts-limit-custom-monthly","metadata":{"seo":{"title":"Get current custom sending limit","description":"Fetch the details of custom sending limit on the account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-v5-accounts-limit-custom-monthly","name":"Get current custom sending limit","isWebhook":false,"pointer":"/paths/~1v5~1accounts~1limit~1custom~1monthly/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get current custom sending limit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch the details of custom sending limit on the account"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/accounts/limit/custom/monthly","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v5/accounts/limit/custom/monthly","href":"custom-message-limit/get-v5-accounts-limit-custom-monthly","openApiOperationId":"get-v5-accounts-limit-custom-monthly","summary":"Get current custom sending limit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-CustomMessageLimitResponse","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1monthly/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-CustomMessageLimitResponse","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1monthly/get/responses/200/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1monthly/get/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1monthly/get/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v5~1accounts~1limit~1custom~1monthly/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-accounts-api-CustomMessageLimitResponse","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1monthly/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-CustomMessageLimitResponse","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1monthly/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1monthly/get/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1monthly/get/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-message-limit/get-v5-accounts-limit-custom-monthly"}],"panels":[]}]},"httpPath":"/v5/accounts/limit/custom/monthly"},{"label":"Set a custom sending limit","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/custom-message-limit/put-v5-accounts-limit-custom-monthly","routeSlug":"/docs/mailgun/api-reference/send/mailgun/custom-message-limit/put-v5-accounts-limit-custom-monthly","metadata":{"seo":{"title":"Set a custom sending limit","description":"Set a custom sending limit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-v5-accounts-limit-custom-monthly","name":"Set a custom sending limit","isWebhook":false,"pointer":"/paths/~1v5~1accounts~1limit~1custom~1monthly/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set a custom sending limit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Set a custom sending limit"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_303","description":"The limit to set","required":true}],"pointer":"/paths/~1v5~1accounts~1limit~1custom~1monthly/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v5/accounts/limit/custom/monthly","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":true,"schemaId":"schema_303"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v5/accounts/limit/custom/monthly","href":"custom-message-limit/put-v5-accounts-limit-custom-monthly","openApiOperationId":"put-v5-accounts-limit-custom-monthly","summary":"Set a custom sending limit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully set the sending limit","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1monthly/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1monthly/put/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1monthly/put/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1monthly/put/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v5~1accounts~1limit~1custom~1monthly/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1monthly/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1monthly/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1monthly/put/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1monthly/put/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-message-limit/put-v5-accounts-limit-custom-monthly"}],"panels":[]}]},"httpPath":"/v5/accounts/limit/custom/monthly"},{"label":"Delete a custom sending limit","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/custom-message-limit/delete-v5-accounts-limit-custom-monthly","routeSlug":"/docs/mailgun/api-reference/send/mailgun/custom-message-limit/delete-v5-accounts-limit-custom-monthly","metadata":{"seo":{"title":"Delete a custom sending limit","description":"Delete a custom sending limit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-v5-accounts-limit-custom-monthly","name":"Delete a custom sending limit","isWebhook":false,"pointer":"/paths/~1v5~1accounts~1limit~1custom~1monthly/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a custom sending limit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a custom sending limit"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v5/accounts/limit/custom/monthly","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v5/accounts/limit/custom/monthly","href":"custom-message-limit/delete-v5-accounts-limit-custom-monthly","openApiOperationId":"delete-v5-accounts-limit-custom-monthly","summary":"Delete a custom sending limit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully deleted the sending limit","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1monthly/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1monthly/delete/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1monthly/delete/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1monthly/delete/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v5~1accounts~1limit~1custom~1monthly/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1monthly/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1monthly/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1monthly/delete/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1monthly/delete/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-message-limit/delete-v5-accounts-limit-custom-monthly"}],"panels":[]}]},"httpPath":"/v5/accounts/limit/custom/monthly"},{"label":"Re-enable account disabled for hitting send limit","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/custom-message-limit/put-v5-accounts-limit-custom-enable","routeSlug":"/docs/mailgun/api-reference/send/mailgun/custom-message-limit/put-v5-accounts-limit-custom-enable","metadata":{"seo":{"title":"Re-enable account disabled for hitting send limit","description":"Re-enable an account that was disabled for reaching the custom sending limit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-v5-accounts-limit-custom-enable","name":"Re-enable account disabled for hitting send limit","isWebhook":false,"pointer":"/paths/~1v5~1accounts~1limit~1custom~1enable/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Re-enable account disabled for hitting send limit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Re-enable an account that was disabled for reaching the custom sending limit"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v5/accounts/limit/custom/enable","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v5/accounts/limit/custom/enable","href":"custom-message-limit/put-v5-accounts-limit-custom-enable","openApiOperationId":"put-v5-accounts-limit-custom-enable","summary":"Re-enable account disabled for hitting send limit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully re-enabled the account","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1enable/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1enable/put/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1enable/put/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1enable/put/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v5~1accounts~1limit~1custom~1enable/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1enable/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1enable/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1enable/put/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1limit~1custom~1enable/put/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-message-limit/put-v5-accounts-limit-custom-enable"}],"panels":[]}]},"httpPath":"/v5/accounts/limit/custom/enable"}],"content":{"contentType":"group","meta":{"name":"Custom Message Limit"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Message Limit","showPageActions":true},{"nodeType":"markdoc","content":"The custom message limit imposes a hard limit on how many messages your account can send during a calendar month."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v5/accounts/limit/custom/monthly","summary":"Get current custom sending limit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-message-limit/get-v5-accounts-limit-custom-monthly","deprecated":false},{"title":"/v5/accounts/limit/custom/monthly","summary":"Set a custom sending limit","prefix":{"name":"put","color":"put"},"badges":[],"link":"/custom-message-limit/put-v5-accounts-limit-custom-monthly","deprecated":false},{"title":"/v5/accounts/limit/custom/monthly","summary":"Delete a custom sending limit","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-message-limit/delete-v5-accounts-limit-custom-monthly","deprecated":false},{"title":"/v5/accounts/limit/custom/enable","summary":"Re-enable account disabled for hitting send limit","prefix":{"name":"put","color":"put"},"badges":[],"link":"/custom-message-limit/put-v5-accounts-limit-custom-enable","deprecated":false}]}]}]}]}},{"type":"separator","label":"Account Management","content":null},{"type":"group","label":"Account Management","link":"/docs/mailgun/api-reference/send/mailgun/account-management","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-management","items":[{"label":"Update variable account settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-management/put-v5-accounts","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-management/put-v5-accounts","metadata":{"seo":{"title":"Update variable account settings","description":"Update variable account settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-v5-accounts","name":"Update variable account settings","isWebhook":false,"pointer":"/paths/~1v5~1accounts/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update variable account settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update variable account settings"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","schemaId":"components/schemas/string","description":"The new account organization name"},{"name":"inactive_session_timeout","in":"query","schemaId":"schema_260","description":"The login session timeout period for inactivity"},{"name":"absolute_session_timeout","in":"query","schemaId":"schema_260","description":"The login session timeout period limit"},{"name":"logout_redirect_url","in":"query","schemaId":"components/schemas/string","description":"The url to redirect to upon logout"}],"pointer":"/paths/~1v5~1accounts/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v5/accounts","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"name","in":"query","required":false,"schemaId":"components/schemas/string"},{"name":"inactive_session_timeout","in":"query","required":false,"schemaId":"schema_260"},{"name":"absolute_session_timeout","in":"query","required":false,"schemaId":"schema_260"},{"name":"logout_redirect_url","in":"query","required":false,"schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v5/accounts","href":"account-management/put-v5-accounts","openApiOperationId":"put-v5-accounts","summary":"Update variable account settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated the account setting(s)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts/put/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts/put/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts/put/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v5~1accounts/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts/put/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts/put/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-management/put-v5-accounts"}],"panels":[]}]},"httpPath":"/v5/accounts"},{"label":"Get webhook signing key saved on the account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-management/get-v5-accounts-http_signing_key","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-management/get-v5-accounts-http_signing_key","metadata":{"seo":{"title":"Get webhook signing key saved on the account","description":"Get webhook signing key saved on the account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-v5-accounts-http_signing_key","name":"Get webhook signing key saved on the account","isWebhook":false,"pointer":"/paths/~1v5~1accounts~1http_signing_key/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get webhook signing key saved on the account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get webhook signing key saved on the account"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/accounts/http_signing_key","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v5/accounts/http_signing_key","href":"account-management/get-v5-accounts-http_signing_key","openApiOperationId":"get-v5-accounts-http_signing_key","summary":"Get webhook signing key saved on the account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-HTTPSigningKey","exampleIds":["paths/~1v5~1accounts~1http_signing_key/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-HTTPSigningKey","exampleIds":["paths/~1v5~1accounts~1http_signing_key/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1http_signing_key/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1http_signing_key/get/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v5~1accounts~1http_signing_key/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-accounts-api-HTTPSigningKey","exampleIds":["paths/~1v5~1accounts~1http_signing_key/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-HTTPSigningKey","exampleIds":["paths/~1v5~1accounts~1http_signing_key/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1http_signing_key/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1http_signing_key/get/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-management/get-v5-accounts-http_signing_key"}],"panels":[]}]},"httpPath":"/v5/accounts/http_signing_key"},{"label":"Create or regenerate webhook signing key on an account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-management/post-v5-accounts-http_signing_key","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-management/post-v5-accounts-http_signing_key","metadata":{"seo":{"title":"Create or regenerate webhook signing key on an account","description":"Create or regenerate webhook signing key on an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-v5-accounts-http_signing_key","name":"Create or regenerate webhook signing key on an account","isWebhook":false,"pointer":"/paths/~1v5~1accounts~1http_signing_key/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or regenerate webhook signing key on an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create or regenerate webhook signing key on an account"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v5/accounts/http_signing_key","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/accounts/http_signing_key","href":"account-management/post-v5-accounts-http_signing_key","openApiOperationId":"post-v5-accounts-http_signing_key","summary":"Create or regenerate webhook signing key on an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-HTTPSigningKey","exampleIds":["paths/~1v5~1accounts~1http_signing_key/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-HTTPSigningKey","exampleIds":["paths/~1v5~1accounts~1http_signing_key/post/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v5~1accounts~1http_signing_key/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-accounts-api-HTTPSigningKey","exampleIds":["paths/~1v5~1accounts~1http_signing_key/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-HTTPSigningKey","exampleIds":["paths/~1v5~1accounts~1http_signing_key/post/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-management/post-v5-accounts-http_signing_key"}],"panels":[]}]},"httpPath":"/v5/accounts/http_signing_key"},{"label":"Get authorized email recipients for a sandbox domain","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-management/get-v5-sandbox-auth_recipients","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-management/get-v5-sandbox-auth_recipients","metadata":{"seo":{"title":"Get authorized email recipients for a sandbox domain","description":"Get webhook signing key saved on the account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-v5-sandbox-auth_recipients","name":"Get authorized email recipients for a sandbox domain","isWebhook":false,"pointer":"/paths/~1v5~1sandbox~1auth_recipients/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get authorized email recipients for a sandbox domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get webhook signing key saved on the account"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/sandbox/auth_recipients","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/sandbox/auth_recipients","href":"account-management/get-v5-sandbox-auth_recipients","openApiOperationId":"get-v5-sandbox-auth_recipients","summary":"Get authorized email recipients for a sandbox domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_306","exampleIds":["paths/~1v5~1sandbox~1auth_recipients/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"schema_306","exampleIds":["paths/~1v5~1sandbox~1auth_recipients/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v5~1sandbox~1auth_recipients/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_306","exampleIds":["paths/~1v5~1sandbox~1auth_recipients/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_306","exampleIds":["paths/~1v5~1sandbox~1auth_recipients/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-management/get-v5-sandbox-auth_recipients"}],"panels":[]}]},"httpPath":"/v5/sandbox/auth_recipients"},{"label":"Add authorized email recipient for a sandbox domain","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-management/post-v5-sandbox-auth_recipients","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-management/post-v5-sandbox-auth_recipients","metadata":{"seo":{"title":"Add authorized email recipient for a sandbox domain","description":"Add authorized email recipient for a sandbox domain"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-v5-sandbox-auth_recipients","name":"Add authorized email recipient for a sandbox domain","isWebhook":false,"pointer":"/paths/~1v5~1sandbox~1auth_recipients/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add authorized email recipient for a sandbox domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add authorized email recipient for a sandbox domain"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"email","in":"query","schemaId":"components/schemas/string","description":"The email address of the new recipient","required":true}],"pointer":"/paths/~1v5~1sandbox~1auth_recipients/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v5/sandbox/auth_recipients","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"email","in":"query","required":true,"schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v5/sandbox/auth_recipients","href":"account-management/post-v5-sandbox-auth_recipients","openApiOperationId":"post-v5-sandbox-auth_recipients","summary":"Add authorized email recipient for a sandbox domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_307","exampleIds":["paths/~1v5~1sandbox~1auth_recipients/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"schema_307","exampleIds":["paths/~1v5~1sandbox~1auth_recipients/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1sandbox~1auth_recipients/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1sandbox~1auth_recipients/post/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v5~1sandbox~1auth_recipients/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_307","exampleIds":["paths/~1v5~1sandbox~1auth_recipients/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_307","exampleIds":["paths/~1v5~1sandbox~1auth_recipients/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1sandbox~1auth_recipients/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1sandbox~1auth_recipients/post/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-management/post-v5-sandbox-auth_recipients"}],"panels":[]}]},"httpPath":"/v5/sandbox/auth_recipients"},{"label":"Remove an authorized sandbox domain email recipient","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-management/delete-v5-sandbox-auth_recipients-email","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-management/delete-v5-sandbox-auth_recipients-email","metadata":{"seo":{"title":"Remove an authorized sandbox domain email recipient","description":"Remove an authorized sandbox domain email recipient"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-v5-sandbox-auth_recipients-email","name":"Remove an authorized sandbox domain email recipient","isWebhook":false,"pointer":"/paths/~1v5~1sandbox~1auth_recipients~1{email}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove an authorized sandbox domain email recipient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove an authorized sandbox domain email recipient"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"email","in":"path","schemaId":"components/schemas/string","description":"The email address of the authorized recipient to be removed","required":true}],"pointer":"/paths/~1v5~1sandbox~1auth_recipients~1{email}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v5/sandbox/auth_recipients/{email}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"email","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v5/sandbox/auth_recipients/{email}","href":"account-management/delete-v5-sandbox-auth_recipients-email","openApiOperationId":"delete-v5-sandbox-auth_recipients-email","summary":"Remove an authorized sandbox domain email recipient"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1sandbox~1auth_recipients~1{email}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1sandbox~1auth_recipients~1{email}/delete/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1sandbox~1auth_recipients~1{email}/delete/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1sandbox~1auth_recipients~1{email}/delete/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v5~1sandbox~1auth_recipients~1{email}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1sandbox~1auth_recipients~1{email}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1sandbox~1auth_recipients~1{email}/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1sandbox~1auth_recipients~1{email}/delete/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1sandbox~1auth_recipients~1{email}/delete/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-management/delete-v5-sandbox-auth_recipients-email"}],"panels":[]}]},"httpPath":"/v5/sandbox/auth_recipients/{email}"},{"label":"Resend account activation email to the account owner","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-management/post-v5-accounts-resend_activation_email","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-management/post-v5-accounts-resend_activation_email","metadata":{"seo":{"title":"Resend account activation email to the account owner","description":"Resend account activation email to the account owner"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-v5-accounts-resend_activation_email","name":"Resend account activation email to the account owner","isWebhook":false,"pointer":"/paths/~1v5~1accounts~1resend_activation_email/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resend account activation email to the account owner","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Resend account activation email to the account owner"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v5/accounts/resend_activation_email","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/accounts/resend_activation_email","href":"account-management/post-v5-accounts-resend_activation_email","openApiOperationId":"post-v5-accounts-resend_activation_email","summary":"Resend account activation email to the account owner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1resend_activation_email/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1resend_activation_email/post/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v5~1accounts~1resend_activation_email/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1resend_activation_email/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1resend_activation_email/post/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-management/post-v5-accounts-resend_activation_email"}],"panels":[]}]},"httpPath":"/v5/accounts/resend_activation_email"},{"label":"Update account feature","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/account-management/put-v5-accounts-features","routeSlug":"/docs/mailgun/api-reference/send/mailgun/account-management/put-v5-accounts-features","metadata":{"seo":{"title":"Update account feature","description":"Update account feature"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-v5-accounts-features","name":"Update account feature","isWebhook":false,"pointer":"/paths/~1v5~1accounts~1features/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update account feature","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update account feature"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_308"}},"schemaId":"schema_308","pointer":"/paths/~1v5~1accounts~1features/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v5/accounts/features","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_308"}},"responseCodes":["200","400"],"pointer":"/v5/accounts/features","href":"account-management/put-v5-accounts-features","openApiOperationId":"put-v5-accounts-features","summary":"Update account feature"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"schema_308","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_308"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1features/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1features/put/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1features/put/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1features/put/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v5~1accounts~1features/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1features/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","exampleIds":["paths/~1v5~1accounts~1features/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1features/put/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","exampleIds":["paths/~1v5~1accounts~1features/put/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-management/put-v5-accounts-features"}],"panels":[]}]},"httpPath":"/v5/accounts/features"}],"content":{"contentType":"group","meta":{"name":"Account Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Management","showPageActions":true},{"nodeType":"markdoc","content":"Perform account-level CRUD operations."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v5/accounts","summary":"Update variable account settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/account-management/put-v5-accounts","deprecated":false},{"title":"/v5/accounts/http_signing_key","summary":"Get webhook signing key saved on the account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-management/get-v5-accounts-http_signing_key","deprecated":false},{"title":"/v5/accounts/http_signing_key","summary":"Create or regenerate webhook signing key on an account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-management/post-v5-accounts-http_signing_key","deprecated":false},{"title":"/v5/sandbox/auth_recipients","summary":"Get authorized email recipients for a sandbox domain","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-management/get-v5-sandbox-auth_recipients","deprecated":false},{"title":"/v5/sandbox/auth_recipients","summary":"Add authorized email recipient for a sandbox domain","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-management/post-v5-sandbox-auth_recipients","deprecated":false},{"title":"/v5/sandbox/auth_recipients/{email}","summary":"Remove an authorized sandbox domain email recipient","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/account-management/delete-v5-sandbox-auth_recipients-email","deprecated":false},{"title":"/v5/accounts/resend_activation_email","summary":"Resend account activation email to the account owner","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-management/post-v5-accounts-resend_activation_email","deprecated":false},{"title":"/v5/accounts/features","summary":"Update account feature","prefix":{"name":"put","color":"put"},"badges":[],"link":"/account-management/put-v5-accounts-features","deprecated":false}]}]}]}]}},{"type":"separator","label":"Keys","content":null},{"type":"group","label":"Keys","link":"/docs/mailgun/api-reference/send/mailgun/keys","routeSlug":"/docs/mailgun/api-reference/send/mailgun/keys","items":[{"label":"List Mailgun API keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/keys/get-v1-keys","routeSlug":"/docs/mailgun/api-reference/send/mailgun/keys/get-v1-keys","metadata":{"seo":{"title":"List Mailgun API keys","description":"List Mailgun API keys"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-keys","name":"List Mailgun API keys","isWebhook":false,"pointer":"/paths/~1v1~1keys/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Mailgun API keys","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List Mailgun API keys"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"domain_name","in":"query","schemaId":"components/schemas/string","description":"Domain name filter for domain keys"},{"name":"kind","in":"query","schemaId":"schema_309","description":"Key kind filter"}],"pointer":"/paths/~1v1~1keys/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/keys","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"domain_name","in":"query","schemaId":"components/schemas/string"},{"name":"kind","in":"query","schemaId":"schema_309"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/keys","href":"keys/get-v1-keys","openApiOperationId":"GET-v1-keys","summary":"List Mailgun API keys"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-cerberus-keys-KeysResp","exampleIds":["paths/~1v1~1keys/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-cerberus-keys-KeysResp","exampleIds":["paths/~1v1~1keys/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1keys/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1keys/get/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1keys/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-cerberus-keys-KeysResp","exampleIds":["paths/~1v1~1keys/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-cerberus-keys-KeysResp","exampleIds":["paths/~1v1~1keys/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1keys/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1keys/get/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keys/get-v1-keys"}],"panels":[]}]},"httpPath":"/v1/keys"},{"label":"Create Mailgun API key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/keys/post-v1-keys","routeSlug":"/docs/mailgun/api-reference/send/mailgun/keys/post-v1-keys","metadata":{"seo":{"title":"Create Mailgun API key","description":"Create Mailgun API key"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v1-keys","name":"Create Mailgun API key","isWebhook":false,"pointer":"/paths/~1v1~1keys/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Mailgun API key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create Mailgun API key"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v1-keys-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/POST-v1-keys-multipart-form-data-RequestBody","pointer":"/paths/~1v1~1keys/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/keys","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/POST-v1-keys-multipart-form-data-RequestBody"}},"responseCodes":["200","403"],"pointer":"/v1/keys","href":"keys/post-v1-keys","openApiOperationId":"POST-v1-keys","summary":"Create Mailgun API key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/POST-v1-keys-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v1-keys-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-cerberus-keys-CreateKeyResp","exampleIds":["paths/~1v1~1keys/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-cerberus-keys-CreateKeyResp","exampleIds":["paths/~1v1~1keys/post/responses/200/content/application~1json/examples/Example"]},{"code":"403","description":"A 403 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1keys/post/responses/403/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1keys/post/responses/403/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1keys/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-cerberus-keys-CreateKeyResp","exampleIds":["paths/~1v1~1keys/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-cerberus-keys-CreateKeyResp","exampleIds":["paths/~1v1~1keys/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1keys/post/responses/403/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1keys/post/responses/403/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keys/post-v1-keys"}],"panels":[]}]},"httpPath":"/v1/keys"},{"label":"Delete Mailgun API key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/keys/delete-v1-keys--key-id-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/keys/delete-v1-keys--key-id-","metadata":{"seo":{"title":"Delete Mailgun API key","description":"Delete Mailgun API key"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v1-keys--key-id-","name":"Delete Mailgun API key","isWebhook":false,"pointer":"/paths/~1v1~1keys~1{key_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Mailgun API key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete Mailgun API key"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key_id","in":"path","schemaId":"components/schemas/string","description":"The Key ID generated by Mailgun on key creation","required":true}],"pointer":"/paths/~1v1~1keys~1{key_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/keys/{key_id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"key_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/keys/{key_id}","href":"keys/delete-v1-keys--key-id-","openApiOperationId":"DELETE-v1-keys--key-id-","summary":"Delete Mailgun API key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1keys~1{key_id}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1keys~1{key_id}/delete/responses/200/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1keys~1{key_id}/delete/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1keys~1{key_id}/delete/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1keys~1{key_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1keys~1{key_id}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1keys~1{key_id}/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1keys~1{key_id}/delete/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1keys~1{key_id}/delete/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keys/delete-v1-keys--key-id-"}],"panels":[]}]},"httpPath":"/v1/keys/{key_id}"},{"label":"Regenerate Mailgun Public API key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/keys/post-v1-keys-public","routeSlug":"/docs/mailgun/api-reference/send/mailgun/keys/post-v1-keys-public","metadata":{"seo":{"title":"Regenerate Mailgun Public API key","description":"Regenerate Mailgun Public API key"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v1-keys-public","name":"Regenerate Mailgun Public API key","isWebhook":false,"pointer":"/paths/~1v1~1keys~1public/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Regenerate Mailgun Public API key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Regenerate Mailgun Public API key"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/keys/public","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/keys/public","href":"keys/post-v1-keys-public","openApiOperationId":"POST-v1-keys-public","summary":"Regenerate Mailgun Public API key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-cerberus-keys-PublicKeyResp","exampleIds":["paths/~1v1~1keys~1public/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-cerberus-keys-PublicKeyResp","exampleIds":["paths/~1v1~1keys~1public/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1keys~1public/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1keys~1public/post/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1keys~1public/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-cerberus-keys-PublicKeyResp","exampleIds":["paths/~1v1~1keys~1public/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-cerberus-keys-PublicKeyResp","exampleIds":["paths/~1v1~1keys~1public/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1keys~1public/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1keys~1public/post/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keys/post-v1-keys-public"}],"panels":[]}]},"httpPath":"/v1/keys/public"}],"content":{"contentType":"group","meta":{"name":"Keys"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Keys","showPageActions":true},{"nodeType":"markdoc","content":"The Keys API lets you view and manage API keys."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/keys","summary":"List Mailgun API keys","prefix":{"name":"get","color":"get"},"badges":[],"link":"/keys/get-v1-keys","deprecated":false},{"title":"/v1/keys","summary":"Create Mailgun API key","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keys/post-v1-keys","deprecated":false},{"title":"/v1/keys/{key_id}","summary":"Delete Mailgun API key","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/keys/delete-v1-keys--key-id-","deprecated":false},{"title":"/v1/keys/public","summary":"Regenerate Mailgun Public API key","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keys/post-v1-keys-public","deprecated":false}]}]}]}]}},{"type":"separator","label":"Credentials","content":null},{"type":"group","label":"Credentials","link":"/docs/mailgun/api-reference/send/mailgun/credentials","routeSlug":"/docs/mailgun/api-reference/send/mailgun/credentials","items":[{"label":"List Mailgun SMTP credential metadata for a given domain","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/credentials/get-v3-domains--domain-name--credentials","routeSlug":"/docs/mailgun/api-reference/send/mailgun/credentials/get-v3-domains--domain-name--credentials","metadata":{"seo":{"title":"List Mailgun SMTP credential metadata for a given domain","description":"List Mailgun SMTP credential metadata for a given domain"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v3-domains--domain-name--credentials","name":"List Mailgun SMTP credential metadata for a given domain","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{domain_name}~1credentials/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Mailgun SMTP credential metadata for a given domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List Mailgun SMTP credential metadata for a given domain"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Hostname filter for credential results","required":true}],"pointer":"/paths/~1v3~1domains~1{domain_name}~1credentials/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"skip","in":"query","schemaId":"schema_299","description":"Number of results to skip, to help with pagination"},{"name":"limit","in":"query","schemaId":"schema_310","description":"Limit results to this many"}],"pointer":"/paths/~1v3~1domains~1{domain_name}~1credentials/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/domains/{domain_name}/credentials","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[{"name":"skip","in":"query","schemaId":"schema_299"},{"name":"limit","in":"query","schemaId":"schema_310"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/domains/{domain_name}/credentials","href":"credentials/get-v3-domains--domain-name--credentials","openApiOperationId":"GET-v3-domains--domain-name--credentials","summary":"List Mailgun SMTP credential metadata for a given domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-cerberus-credentials-ListCredsResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-cerberus-credentials-ListCredsResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials/get/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{domain_name}~1credentials/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-cerberus-credentials-ListCredsResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-cerberus-credentials-ListCredsResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials/get/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credentials/get-v3-domains--domain-name--credentials"}],"panels":[]}]},"httpPath":"/v3/domains/{domain_name}/credentials"},{"label":"Create Mailgun SMTP credentials for a given domain","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/credentials/post-v3-domains--domain-name--credentials","routeSlug":"/docs/mailgun/api-reference/send/mailgun/credentials/post-v3-domains--domain-name--credentials","metadata":{"seo":{"title":"Create Mailgun SMTP credentials for a given domain","description":"Create Mailgun SMTP credentials for a given domain"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v3-domains--domain-name--credentials","name":"Create Mailgun SMTP credentials for a given domain","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{domain_name}~1credentials/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Mailgun SMTP credentials for a given domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create Mailgun SMTP credentials for a given domain"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Hostname for new credentials","required":true}],"pointer":"/paths/~1v3~1domains~1{domain_name}~1credentials/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domains-domain_name-credentials-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/POST-v3-domains-domain_name-credentials-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1domains~1{domain_name}~1credentials/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/domains/{domain_name}/credentials","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domains-domain_name-credentials-multipart-form-data-RequestBody"}},"responseCodes":["200","400"],"pointer":"/v3/domains/{domain_name}/credentials","href":"credentials/post-v3-domains--domain-name--credentials","openApiOperationId":"POST-v3-domains--domain-name--credentials","summary":"Create Mailgun SMTP credentials for a given domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/POST-v3-domains-domain_name-credentials-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v3-domains-domain_name-credentials-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-cerberus-credentials-CreateCredsResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-cerberus-credentials-CreateCredsResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials/post/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{domain_name}~1credentials/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-cerberus-credentials-CreateCredsResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-cerberus-credentials-CreateCredsResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials/post/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credentials/post-v3-domains--domain-name--credentials"}],"panels":[]}]},"httpPath":"/v3/domains/{domain_name}/credentials"},{"label":"Delete all Mailgun SMTP credentials for a domain","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/credentials/delete-v3-domains--domain-name--credentials","routeSlug":"/docs/mailgun/api-reference/send/mailgun/credentials/delete-v3-domains--domain-name--credentials","metadata":{"seo":{"title":"Delete all Mailgun SMTP credentials for a domain","description":"Delete Mailgun SMTP credentials for a given domain"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3-domains--domain-name--credentials","name":"Delete all Mailgun SMTP credentials for a domain","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{domain_name}~1credentials/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete all Mailgun SMTP credentials for a domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete Mailgun SMTP credentials for a given domain"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Hostname of credentials to be deleted","required":true}],"pointer":"/paths/~1v3~1domains~1{domain_name}~1credentials/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/domains/{domain_name}/credentials","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/domains/{domain_name}/credentials","href":"credentials/delete-v3-domains--domain-name--credentials","openApiOperationId":"DELETE-v3-domains--domain-name--credentials","summary":"Delete all Mailgun SMTP credentials for a domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-cerberus-credentials-DeleteDomainCredsResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-cerberus-credentials-DeleteDomainCredsResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials/delete/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials/delete/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials/delete/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{domain_name}~1credentials/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-cerberus-credentials-DeleteDomainCredsResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-cerberus-credentials-DeleteDomainCredsResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials/delete/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials/delete/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credentials/delete-v3-domains--domain-name--credentials"}],"panels":[]}]},"httpPath":"/v3/domains/{domain_name}/credentials"},{"label":"Update Mailgun SMTP credentials","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/credentials/put-v3-domains--domain-name--credentials--spec-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/credentials/put-v3-domains--domain-name--credentials--spec-","metadata":{"seo":{"title":"Update Mailgun SMTP credentials","description":"Update Mailgun SMTP credentials for a given domain and SMTP user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v3-domains--domain-name--credentials--spec-","name":"Update Mailgun SMTP credentials","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Mailgun SMTP credentials","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update Mailgun SMTP credentials for a given domain and SMTP user"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Hostname of credentials to be updated","required":true},{"name":"spec","in":"path","schemaId":"components/schemas/string","description":"Login specification of credentials to be updated (email address)","required":true}],"pointer":"/paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domains-domain_name-credentials-spec-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/PUT-v3-domains-domain_name-credentials-spec-multipart-form-data-RequestBody","pointer":"/paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/domains/{domain_name}/credentials/{spec}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"spec","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domains-domain_name-credentials-spec-multipart-form-data-RequestBody"}},"responseCodes":["200","404"],"pointer":"/v3/domains/{domain_name}/credentials/{spec}","href":"credentials/put-v3-domains--domain-name--credentials--spec-","openApiOperationId":"PUT-v3-domains--domain-name--credentials--spec-","summary":"Update Mailgun SMTP credentials"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/PUT-v3-domains-domain_name-credentials-spec-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v3-domains-domain_name-credentials-spec-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-cerberus-credentials-CreateCredsResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-cerberus-credentials-CreateCredsResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/put/responses/200/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/put/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/put/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-cerberus-credentials-CreateCredsResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-cerberus-credentials-CreateCredsResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/put/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/put/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credentials/put-v3-domains--domain-name--credentials--spec-"}],"panels":[]}]},"httpPath":"/v3/domains/{domain_name}/credentials/{spec}"},{"label":"Delete Mailgun SMTP credentials","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/credentials/delete-v3-domains--domain-name--credentials--spec-","routeSlug":"/docs/mailgun/api-reference/send/mailgun/credentials/delete-v3-domains--domain-name--credentials--spec-","metadata":{"seo":{"title":"Delete Mailgun SMTP credentials","description":"Delete Mailgun SMTP credentials for a given domain and SMTP user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v3-domains--domain-name--credentials--spec-","name":"Delete Mailgun SMTP credentials","isWebhook":false,"pointer":"/paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Mailgun SMTP credentials","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete Mailgun SMTP credentials for a given domain and SMTP user"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_name","in":"path","schemaId":"components/schemas/string","description":"Hostname of credentials to be deleted","required":true},{"name":"spec","in":"path","schemaId":"components/schemas/string","description":"Login specification of credentials to be deleted (email address)","required":true}],"pointer":"/paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/domains/{domain_name}/credentials/{spec}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain_name","in":"path","required":true,"schemaId":"components/schemas/string"},{"name":"spec","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/domains/{domain_name}/credentials/{spec}","href":"credentials/delete-v3-domains--domain-name--credentials--spec-","openApiOperationId":"DELETE-v3-domains--domain-name--credentials--spec-","summary":"Delete Mailgun SMTP credentials"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-cerberus-credentials-DeleteCredsResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-cerberus-credentials-DeleteCredsResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/delete/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/delete/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/delete/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-cerberus-credentials-DeleteCredsResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-cerberus-credentials-DeleteCredsResp","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/delete/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/delete/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credentials/delete-v3-domains--domain-name--credentials--spec-"}],"panels":[]}]},"httpPath":"/v3/domains/{domain_name}/credentials/{spec}"}],"content":{"contentType":"group","meta":{"name":"Credentials"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credentials","showPageActions":true},{"nodeType":"markdoc","content":"The Credentials API lets you view and manage SMTP credentials."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/domains/{domain_name}/credentials","summary":"List Mailgun SMTP credential metadata for a given domain","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credentials/get-v3-domains--domain-name--credentials","deprecated":false},{"title":"/v3/domains/{domain_name}/credentials","summary":"Create Mailgun SMTP credentials for a given domain","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credentials/post-v3-domains--domain-name--credentials","deprecated":false},{"title":"/v3/domains/{domain_name}/credentials","summary":"Delete all Mailgun SMTP credentials for a domain","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/credentials/delete-v3-domains--domain-name--credentials","deprecated":false},{"title":"/v3/domains/{domain_name}/credentials/{spec}","summary":"Update Mailgun SMTP credentials","prefix":{"name":"put","color":"put"},"badges":[],"link":"/credentials/put-v3-domains--domain-name--credentials--spec-","deprecated":false},{"title":"/v3/domains/{domain_name}/credentials/{spec}","summary":"Delete Mailgun SMTP credentials","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/credentials/delete-v3-domains--domain-name--credentials--spec-","deprecated":false}]}]}]}]}},{"type":"separator","label":"IP Allowlist","content":null},{"type":"group","label":"IP Allowlist","link":"/docs/mailgun/api-reference/send/mailgun/ip-allowlist","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ip-allowlist","items":[{"label":"List Mailgun account IP allowlist entries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ip-allowlist/get-v2-ip-whitelist","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ip-allowlist/get-v2-ip-whitelist","metadata":{"seo":{"title":"List Mailgun account IP allowlist entries","description":"List Mailgun account IP allowlist entries"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v2-ip-whitelist","name":"List Mailgun account IP allowlist entries","isWebhook":false,"pointer":"/paths/~1v2~1ip_whitelist/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Mailgun account IP allowlist entries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List Mailgun account IP allowlist entries"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/ip_whitelist","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/v2/ip_whitelist","href":"ip-allowlist/get-v2-ip-whitelist","openApiOperationId":"GET-v2-ip-whitelist","summary":"List Mailgun account IP allowlist entries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-cerberus-whitelist-V2WhitelistResp","exampleIds":["paths/~1v2~1ip_whitelist/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-cerberus-whitelist-V2WhitelistResp","exampleIds":["paths/~1v2~1ip_whitelist/get/responses/200/content/application~1json/examples/Example"]},{"code":"403","description":"A 403 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v2~1ip_whitelist/get/responses/403/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v2~1ip_whitelist/get/responses/403/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v2~1ip_whitelist/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-cerberus-whitelist-V2WhitelistResp","exampleIds":["paths/~1v2~1ip_whitelist/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-cerberus-whitelist-V2WhitelistResp","exampleIds":["paths/~1v2~1ip_whitelist/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v2~1ip_whitelist/get/responses/403/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v2~1ip_whitelist/get/responses/403/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-allowlist/get-v2-ip-whitelist"}],"panels":[]}]},"httpPath":"/v2/ip_whitelist"},{"label":"Update individual Mailgun account IP allowlist entry's description","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ip-allowlist/put-v2-ip-whitelist","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ip-allowlist/put-v2-ip-whitelist","metadata":{"seo":{"title":"Update individual Mailgun account IP allowlist entry's description","description":"Update individual Mailgun account IP allowlist entry's description"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v2-ip-whitelist","name":"Update individual Mailgun account IP allowlist entry's description","isWebhook":false,"pointer":"/paths/~1v2~1ip_whitelist/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update individual Mailgun account IP allowlist entry's description","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update individual Mailgun account IP allowlist entry's description"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v2-ip_whitelist-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/PUT-v2-ip_whitelist-multipart-form-data-RequestBody","pointer":"/paths/~1v2~1ip_whitelist/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/ip_whitelist","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v2-ip_whitelist-multipart-form-data-RequestBody"}},"responseCodes":["200","400"],"pointer":"/v2/ip_whitelist","href":"ip-allowlist/put-v2-ip-whitelist","openApiOperationId":"PUT-v2-ip-whitelist","summary":"Update individual Mailgun account IP allowlist entry's description"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/PUT-v2-ip_whitelist-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PUT-v2-ip_whitelist-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-cerberus-whitelist-V2WhitelistResp","exampleIds":["paths/~1v2~1ip_whitelist/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-cerberus-whitelist-V2WhitelistResp","exampleIds":["paths/~1v2~1ip_whitelist/put/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v2~1ip_whitelist/put/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v2~1ip_whitelist/put/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v2~1ip_whitelist/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-cerberus-whitelist-V2WhitelistResp","exampleIds":["paths/~1v2~1ip_whitelist/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-cerberus-whitelist-V2WhitelistResp","exampleIds":["paths/~1v2~1ip_whitelist/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v2~1ip_whitelist/put/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v2~1ip_whitelist/put/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-allowlist/put-v2-ip-whitelist"}],"panels":[]}]},"httpPath":"/v2/ip_whitelist"},{"label":"Add Mailgun account IP allowlist entry","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ip-allowlist/post-v2-ip-whitelist","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ip-allowlist/post-v2-ip-whitelist","metadata":{"seo":{"title":"Add Mailgun account IP allowlist entry","description":"Add Mailgun account IP allowlist entry"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v2-ip-whitelist","name":"Add Mailgun account IP allowlist entry","isWebhook":false,"pointer":"/paths/~1v2~1ip_whitelist/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Mailgun account IP allowlist entry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add Mailgun account IP allowlist entry"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v2-ip_whitelist-multipart-form-data-RequestBody"}},"schemaId":"components/schemas/POST-v2-ip_whitelist-multipart-form-data-RequestBody","pointer":"/paths/~1v2~1ip_whitelist/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/ip_whitelist","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/POST-v2-ip_whitelist-multipart-form-data-RequestBody"}},"responseCodes":["200","400"],"pointer":"/v2/ip_whitelist","href":"ip-allowlist/post-v2-ip-whitelist","openApiOperationId":"POST-v2-ip-whitelist","summary":"Add Mailgun account IP allowlist entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/POST-v2-ip_whitelist-multipart-form-data-RequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/POST-v2-ip_whitelist-multipart-form-data-RequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-cerberus-whitelist-V2WhitelistResp","exampleIds":["paths/~1v2~1ip_whitelist/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-cerberus-whitelist-V2WhitelistResp","exampleIds":["paths/~1v2~1ip_whitelist/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v2~1ip_whitelist/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v2~1ip_whitelist/post/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v2~1ip_whitelist/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-cerberus-whitelist-V2WhitelistResp","exampleIds":["paths/~1v2~1ip_whitelist/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-cerberus-whitelist-V2WhitelistResp","exampleIds":["paths/~1v2~1ip_whitelist/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v2~1ip_whitelist/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v2~1ip_whitelist/post/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-allowlist/post-v2-ip-whitelist"}],"panels":[]}]},"httpPath":"/v2/ip_whitelist"},{"label":"Delete Mailgun account IP allowlist entry","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/ip-allowlist/delete-v2-ip-whitelist","routeSlug":"/docs/mailgun/api-reference/send/mailgun/ip-allowlist/delete-v2-ip-whitelist","metadata":{"seo":{"title":"Delete Mailgun account IP allowlist entry","description":"Delete Mailgun account IP allowlist entry"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v2-ip-whitelist","name":"Delete Mailgun account IP allowlist entry","isWebhook":false,"pointer":"/paths/~1v2~1ip_whitelist/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Mailgun account IP allowlist entry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete Mailgun account IP allowlist entry"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"address","in":"query","schemaId":"components/schemas/string","description":"Address to be deleted from allowlist","required":true}],"pointer":"/paths/~1v2~1ip_whitelist/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/ip_whitelist","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"address","in":"query","required":true,"schemaId":"components/schemas/string"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v2/ip_whitelist","href":"ip-allowlist/delete-v2-ip-whitelist","openApiOperationId":"DELETE-v2-ip-whitelist","summary":"Delete Mailgun account IP allowlist entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-cerberus-whitelist-V2WhitelistResp","exampleIds":["paths/~1v2~1ip_whitelist/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-cerberus-whitelist-V2WhitelistResp","exampleIds":["paths/~1v2~1ip_whitelist/delete/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v2~1ip_whitelist/delete/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v2~1ip_whitelist/delete/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v2~1ip_whitelist/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-cerberus-whitelist-V2WhitelistResp","exampleIds":["paths/~1v2~1ip_whitelist/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-cerberus-whitelist-V2WhitelistResp","exampleIds":["paths/~1v2~1ip_whitelist/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v2~1ip_whitelist/delete/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v2~1ip_whitelist/delete/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-allowlist/delete-v2-ip-whitelist"}],"panels":[]}]},"httpPath":"/v2/ip_whitelist"}],"content":{"contentType":"group","meta":{"name":"IP Allowlist"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"IP Allowlist","showPageActions":true},{"nodeType":"markdoc","content":"The IP Allowlist API lets you view and manage allowlisted IP addresses to which API key and SMTP credential usage is restricted."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/ip_whitelist","summary":"List Mailgun account IP allowlist entries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ip-allowlist/get-v2-ip-whitelist","deprecated":false},{"title":"/v2/ip_whitelist","summary":"Update individual Mailgun account IP allowlist entry's description","prefix":{"name":"put","color":"put"},"badges":[],"link":"/ip-allowlist/put-v2-ip-whitelist","deprecated":false},{"title":"/v2/ip_whitelist","summary":"Add Mailgun account IP allowlist entry","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ip-allowlist/post-v2-ip-whitelist","deprecated":false},{"title":"/v2/ip_whitelist","summary":"Delete Mailgun account IP allowlist entry","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/ip-allowlist/delete-v2-ip-whitelist","deprecated":false}]}]}]}]}},{"type":"separator","label":"Users","content":null},{"type":"group","label":"Users","link":"/docs/mailgun/api-reference/send/mailgun/users","routeSlug":"/docs/mailgun/api-reference/send/mailgun/users","items":[{"label":"Get users on an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/users/get-v5-users","routeSlug":"/docs/mailgun/api-reference/send/mailgun/users/get-v5-users","metadata":{"seo":{"title":"Get users on an account","description":"Get users on an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-v5-users","name":"Get users on an account","isWebhook":false,"pointer":"/paths/~1v5~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get users on an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get users on an account"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"role","in":"query","schemaId":"schema_311","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user role by which to filter results (basic == analyst)"},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_260","description":"The number of users to return"},{"name":"skip","in":"query","schemaId":"schema_260","description":"The number of users to skip"}],"pointer":"/paths/~1v5~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/users","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"role","in":"query","required":false,"schemaId":"schema_311"},{"name":"limit","in":"query","required":false,"schemaId":"schema_260"},{"name":"skip","in":"query","required":false,"schemaId":"schema_260"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/users","href":"users/get-v5-users","openApiOperationId":"get-v5-users","summary":"Get users on an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-users-api-UserListResponse","exampleIds":["paths/~1v5~1users/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-users-api-UserListResponse","exampleIds":["paths/~1v5~1users/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v5~1users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-users-api-UserListResponse","exampleIds":["paths/~1v5~1users/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-users-api-UserListResponse","exampleIds":["paths/~1v5~1users/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/get-v5-users"}],"panels":[]}]},"httpPath":"/v5/users"},{"label":"Get a user's details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/users/get-v5-users-user_id","routeSlug":"/docs/mailgun/api-reference/send/mailgun/users/get-v5-users-user_id","metadata":{"seo":{"title":"Get a user's details","description":"Get details for a user on the account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-v5-users-user_id","name":"Get a user's details","isWebhook":false,"pointer":"/paths/~1v5~1users~1{user_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a user's details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get details for a user on the account"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"components/schemas/string","description":"The ID of the user on the account","required":true}],"pointer":"/paths/~1v5~1users~1{user_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/users/{user_id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v5/users/{user_id}","href":"users/get-v5-users-user_id","openApiOperationId":"get-v5-users-user_id","summary":"Get a user's details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-users-api-UserResponse","exampleIds":["paths/~1v5~1users~1{user_id}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-users-api-UserResponse","exampleIds":["paths/~1v5~1users~1{user_id}/get/responses/200/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-users-api-GenericResponse","exampleIds":["paths/~1v5~1users~1{user_id}/get/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-users-api-GenericResponse","exampleIds":["paths/~1v5~1users~1{user_id}/get/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v5~1users~1{user_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-users-api-UserResponse","exampleIds":["paths/~1v5~1users~1{user_id}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-users-api-UserResponse","exampleIds":["paths/~1v5~1users~1{user_id}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-users-api-GenericResponse","exampleIds":["paths/~1v5~1users~1{user_id}/get/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-users-api-GenericResponse","exampleIds":["paths/~1v5~1users~1{user_id}/get/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/get-v5-users-user_id"}],"panels":[]}]},"httpPath":"/v5/users/{user_id}"},{"label":"Get one's own user details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/mailgun/api-reference/send/mailgun/users/get-v5-users-me","routeSlug":"/docs/mailgun/api-reference/send/mailgun/users/get-v5-users-me","metadata":{"seo":{"title":"Get one's own user details","description":"Get one's own user details, requires use of an API key with a user_id saved on it, typically of 'web' kind"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-v5-users-me","name":"Get one's own user details","isWebhook":false,"pointer":"/paths/~1v5~1users~1me/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get one's own user details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get one's own user details, requires use of an API key with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" saved on it, typically of 'web' kind"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/users/me","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/v5/users/me","href":"users/get-v5-users-me","openApiOperationId":"get-v5-users-me","summary":"Get one's own user details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-users-api-UserResponse","exampleIds":["paths/~1v5~1users~1me/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-users-api-UserResponse","exampleIds":["paths/~1v5~1users~1me/get/responses/200/content/application~1json/examples/Example"]},{"code":"403","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-users-api-GenericResponse","exampleIds":["paths/~1v5~1users~1me/get/responses/403/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-users-api-GenericResponse","exampleIds":["paths/~1v5~1users~1me/get/responses/403/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v5~1users~1me/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-users-api-UserResponse","exampleIds":["paths/~1v5~1users~1me/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-users-api-UserResponse","exampleIds":["paths/~1v5~1users~1me/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-users-api-GenericResponse","exampleIds":["paths/~1v5~1users~1me/get/responses/403/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-users-api-GenericResponse","exampleIds":["paths/~1v5~1users~1me/get/responses/403/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/get-v5-users-me"}],"panels":[]}]},"httpPath":"/v5/users/me"}],"content":{"contentType":"group","meta":{"name":"Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","showPageActions":true},{"nodeType":"markdoc","content":"Mailgun API supports viewing user entities."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v5/users","summary":"Get users on an account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/get-v5-users","deprecated":false},{"title":"/v5/users/{user_id}","summary":"Get a user's details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/get-v5-users-user_id","deprecated":false},{"title":"/v5/users/me","summary":"Get one's own user details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/get-v5-users-me","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/github.com-mailgun-influx-httpapi-SendMessageResponse":{"id":"components/schemas/github.com-mailgun-influx-httpapi-SendMessageResponse","kind":"json-schema","title":"github.com-mailgun-influx-httpapi-SendMessageResponse","data":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the message as defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc2392"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC-2392"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"message":{"type":"string","description":"A success message"}},"required":["id","message"]}},"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound":{"id":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","kind":"json-schema","title":"github.com-mailgun-influx-httpapi-GetMessageResponseNotFound","data":{"type":"object","properties":{"message":{"type":"string","description":"A failure message"}},"required":["message"]}},"components/schemas/string":{"id":"components/schemas/string","kind":"json-schema","title":"string","data":{"type":"string"}},"components/schemas/POST-v3-domain_name-messages-multipart-form-data-RequestBody":{"id":"components/schemas/POST-v3-domain_name-messages-multipart-form-data-RequestBody","kind":"json-schema","title":"POST-v3-domain_name-messages-multipart-form-data-RequestBody","data":{"type":"object","properties":{"from":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email address of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"From"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Can include a friendly name using the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Friendly Name <email@domain.com>\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Note: not required if sending with a template that has a pre-set From header, but will override the template's From header if provided."},"children":[]}]}]}]},"to":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email address of the recipient(s). Supports friendly name format. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Bob <bob@host.com>\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use commas to separate multiple recipients. Duplicate addresses are automatically ignored."},"children":[]}]}]}]},"cc":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but for carbon copy recipients. Supports friendly name format."},"children":[]}]}]}]},"bcc":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but for blind carbon copy recipients. Supports friendly name format."},"children":[]}]}]}]},"subject":{"type":"string","description":"Message subject. Note: not required if sending with a template that has a pre-set Subject header, but it will override it if provided."},"text":{"type":"string","description":"Body of the message (text version)"},"html":{"type":"string","description":"Body of the message (HTML version)"},"amp-html":{"type":"string","description":"AMP part of the message.  Please follow Google guidelines to compose and send AMP emails"},"attachment":{"type":"array","items":{"type":"string","format":"binary"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File attachment.  You can post multiple "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values.  "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You must use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipart/form-data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" encoding for sending attachments"},"children":[]}]}]}]},"inline":{"type":"array","items":{"type":"string","format":"binary"},"format":"binary","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attachment with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" disposition.  Can be used to send inline images (see example). You can post multiple "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values"},"children":[]}]}]}]},"template":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of a template stored via the Templates API to use to render the email body. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/send-templates"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information"},"children":[]}]}]}]},"t:version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Render a specific version of the given template instead of the latest version. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"template"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option must also be provided."},"children":[]}]}]}]},"t:text":{"type":"string","enum":["yes"],"description":"Generates a plain text version of the template alongside the HTML version when sending templated emails. When set to 'yes', instructs Mailgun to create a text/plain MIME part based on the template content, ensuring compatibility with email clients that don't support HTML or have HTML rendering disabled. This improves email deliverability and accessibility by providing a fallback text version in multipart emails.","x-enumDescriptions":{"yes":"Render template in the text part of the message"}},"t:variables":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid JSON-encoded dictionary used as the input for template variable expansion.  See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/send-templates"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information"},"children":[]}]}]}]},"o:tag":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag string.  See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/tracking-messages/track-tagging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tagging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information"},"children":[]}]}]}]},"o:dkim":{"type":"string","enum":["yes","no","true","false"],"description":"Enables or disables DKIM signatures on a per-message basis. Overrides the domain-level DKIM setting for this specific message.","x-enumDescriptions":{"yes":"Enables DKIM signatures","no":"Disable DKIM signatures","true":"Enables DKIM signatures","false":"Disable DKIM signatures"}},"o:secondary-dkim":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify a second domain key to sign the email with. The value is formatted as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"signing_domain/selector"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"example.com/s1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This tells Mailgun to sign the message with the signing domain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"example.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using the selector "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"s1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Note: the domain key specified must have been previously created and activated."},"children":[]}]}]}]},"o:secondary-dkim-public":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify an alias of the domain key specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"o:secondary-dkim"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Also formatted as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"public_signing_domain/selector"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"o:secondary-dkim"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option must also be provided. Mailgun will sign the message with the provided key of the secondary DKIM, but use the public secondary DKIM name and selector. Note: We will perform a DNS check prior to signing the message to ensure the public keys matches the secondary DKIM."},"children":[]}]}]}]},"o:deliverytime":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the scheduled delivery time in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/api-overview#date-format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC-2822 format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Depending on your plan, you can schedule messages up to 3 or 7 days in advance. If your domain has a custom message_ttl (time-to-live) setting, this value determines the maximum scheduling duration. Example: 'Fri, 14 Oct 2011 12:00:00 +0000'"},"children":[]}]}]}]},"o:deliver-within":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the maximum time window for delivering the message. Accepts values in format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[0-9]+h[0-9]+m"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1h30m"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"30m"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), with a minimum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5m"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and maximum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For scheduled messages, the delivery window starts from the scheduled time. The standard retry schedule applies within this window, so shorter timeframes may result in fewer delivery attempts."},"children":[]}]}]}]},"o:deliverytime-optimize-period":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Toggles Send Time Optimization (STO) on a per-message basis.  String should be set to the number of hours in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[0-9]+h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format, with the minimum being "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the maximum being "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"72h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  This value defines the time window in which Mailgun will run the optimization algorithm based on prior engagement data of a given recipient. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/send-sto"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sending a Message with STO"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details. "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that STO is only available on certain plans. See www.mailgun.com/pricing for more info"},"children":[]}]}]}]}]},"o:time-zone-localize":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Toggles Timezone Optimization (TZO) on a per message basis. String should be set to preferred delivery time in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:mm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hh:mmaa"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:mm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used for 24 hour format without AM/PM and hh:mmaa is used for 12 hour format with AM/PM. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/send-tzo"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sending a Message with TZO"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details. "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that TZO is only available on certain plans. See www.mailgun.com/pricing for more info"},"children":[]}]}]}]}]},"o:testmode":{"type":"string","enum":["yes"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enables sending in test mode. Messages are processed normally but not actually delivered to recipients. Useful for testing without sending real emails. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/test-mode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sending in Test Mode"},"children":[]}]}]}]}],"x-enumDescriptions":{"yes":"Send in test mode"}},"o:tracking":{"type":"string","enum":["yes","no","true","false","htmlonly"],"description":"Toggles both click and open tracking on a per-message basis","x-enumDescriptions":{"yes":"Enable tracking on a per-message basis","no":"Disable tracking on a per-message basis","true":"Enable tracking on a per-message basis","false":"Disable tracking on a per-message basis","htmlonly":"Use if you only want links rewritten in the HTML part of the message"}},"o:tracking-clicks":{"type":"string","enum":["yes","no","true","false","htmlonly"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Toggles click tracking on a per-message basis, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/tracking-messages/tracking-clicks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking Clicks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  This overrides the domain-level click tracking setting."},"children":[]}]}]}],"x-enumDescriptions":{"yes":"Enable tracking on a per-message basis","no":"Disable tracking on a per-message basis","true":"Enable tracking on a per-message basis","false":"Disable tracking on a per-message basis","htmlonly":"Use if you only want links rewritten in the HTML part of the message"}},"o:tracking-opens":{"type":"string","enum":["yes","no","true","false"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Toggles opens tracking on a per-message basis, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/tracking-messages/tracking-opens"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking Opens"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  Has higher priority than domain-level setting."},"children":[]}]}]}],"x-enumDescriptions":{"yes":"Enables opens tracking","no":"Disable opens tracking","true":"Enables opens tracking","false":"Disable opens tracking"}},"o:require-tls":{"type":"string","enum":["yes","no","true","false"],"description":"When set to 'yes', requires the message to be sent only over a TLS connection to the Email Service Provider. If TLS cannot be established, the message will not be delivered. When set to 'no' (default), Mailgun attempts TLS but falls back to plaintext SMTP if needed.","x-enumDescriptions":{"yes":"Message only be sent over a TLS connection","no":"Message do not require to be sent over a TLS connection","true":"Message only be sent over a TLS connection","false":"Message do not require to be sent over a TLS connection"}},"o:skip-verification":{"type":"string","enum":["yes","no","true","false"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the certificate and hostname of the resolved MX Host will not be verified when trying to establish a TLS connection. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Mailgun will verify the certificate and hostname. If either one can not be verified, a TLS connection will not be established. The default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]}]}]}],"x-enumDescriptions":{"yes":"Verification skipped","no":"Verification active","true":"Verification skipped","false":"Verification active"}},"o:sending-ip":{"type":"string","description":"Used to specify an IP Address to send an email that is owned by your account"},"o:sending-ip-pool":{"type":"string","description":"If an IP Pool ID is provided, the email will be delivered with an IP that belongs in that pool"},"o:tracking-pixel-location-top":{"type":"string","enum":["yes","no","true","false","htmlonly"],"description":"Places the tracking pixel at the top of emails instead of the bottom. Useful for long emails that may be truncated or have rendering issues, ensuring open tracking works accurately.","x-enumDescriptions":{"yes":"Enables tracking","no":"Disable tracking","true":"Enables tracking","false":"Disable tracking","htmlonly":"Use if you only want links rewritten in the HTML part of the message"}},"o:archive-to":{"type":"string","description":"Sends a copy of successfully delivered messages to the specified URL via HTTP POST. The request uses Content-Type: application/mime and contains the exact message the recipient's SMTP server received. NOTE: These are accounted for and billed as delivered messages"},"o:suppress-headers":{"type":"string","description":"Removes specified X-Mailgun headers from the delivered message. Provide header names separated by commas (e.g., 'X-Mailgun-Variables,X-Mailgun-Tag') or use 'all' to remove all X-Mailgun headers.Note: X-Mailgun-Sid header is currently used to process complains received via feedback loops."},"o:inbox-placement-test-key":{"type":"string","description":"Triggers an Inbox Placement test for this message using the provided value as an idempotency key. Retried or duplicate send requests that use the same key will not create additional tests. Requires Inbox Placement to be enabled for your account."},"h:X-My-Header":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds custom headers to the email. Use 'h:' prefix followed by header name and value. Example: 'h:X-Custom-Header=my-value'"},"children":[]}]}]}]},"v:my-var":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attaches custom data to the message using the 'v:' prefix followed by a variable name. When sending with templates, provides values for template variable substitution (overridden by 't:variables' if both are provided). When not using templates, treated as metadata and included in events/webhooks. Variables are visible in the delivered email's X-Mailgun-Variables header. Example: 'v:user-id=123'. NOTE: Anything over 4KB will be truncated in the event/webhooks."},"children":[]}]}]}]},"recipient-variables":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A JSON-encoded dictionary for batch sending with personalized variables per recipient. Each key is a recipient email address, each value is a dictionary of variables for that recipient. Variables can be referenced in the message using %recipient.variablename%. Example: '{\"alice@example.com\": {\"name\":\"Alice\", \"id\":1}, \"bob@example.com\": {\"name\":\"Bob\", \"id\":2}}'. Maximum 1,000 recipients per batch. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/batch-sending"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Batch Sending"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information"},"children":[]}]}]}]}},"required":["from","to","subject"],"additionalProperties":true}},"components/schemas/POST-v3-domain_name-messages-mime-multipart-form-data-RequestBody":{"id":"components/schemas/POST-v3-domain_name-messages-mime-multipart-form-data-RequestBody","kind":"json-schema","title":"POST-v3-domain_name-messages-mime-multipart-form-data-RequestBody","data":{"type":"object","properties":{"to":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email address of the recipient(s). Supports friendly name format. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Bob <bob@host.com>\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use commas to separate multiple recipients. Duplicate addresses are automatically ignored."},"children":[]}]}]}]},"message":{"type":"string","format":"binary","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MIME string of the message.  Make sure to use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipart/form-data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" content type to send this as a file upload"},"children":[]}]}]}]},"template":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of a template stored via template API to use to render the email body. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/send-templates"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information"},"children":[]}]}]}]},"t:version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Render a specific version of the given template instead of the latest version. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"template"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option must also be provided."},"children":[]}]}]}]},"t:text":{"type":"string","enum":["yes"],"description":"Generates a plain text version of the template alongside the HTML version when sending templated emails. When set to 'yes', instructs Mailgun to create a text/plain MIME part based on the template content, ensuring compatibility with email clients that don't support HTML or have HTML rendering disabled. This improves email deliverability and accessibility by providing a fallback text version in multipart emails.","x-enumDescriptions":{"yes":"Render template in the text part of the message"}},"t:variables":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid JSON-encoded dictionary used as the input for template variable expansion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/send-templates"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information"},"children":[]}]}]}]},"o:tag":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag string.  See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/tracking-messages/track-tagging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information"},"children":[]}]}]}]},"o:dkim":{"type":"string","enum":["yes","no","true","false"],"description":"Enables or disables DKIM signatures on a per-message basis. Overrides the domain-level DKIM setting for this specific message.","x-enumDescriptions":{"yes":"Enables DKIM signatures","no":"Disable DKIM signatures","true":"Enables DKIM signatures","false":"Disable DKIM signatures"}},"o:secondary-dkim":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify a second domain key to sign the email with. The value is formatted as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"signing_domain/selector"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"example.com/s1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This tells Mailgun to sign the message with the signing domain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"example.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using the selector "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"s1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Note: the domain key specified must have been previously created and activated."},"children":[]}]}]}]},"o:secondary-dkim-public":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify an alias of the domain key specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"o:secondary-dkim"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Also formatted as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"public_signing_domain/selector"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"o:secondary-dkim"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option must also be provided. Mailgun will sign the message with the provided key of the secondary DKIM, but use the public secondary DKIM name and selector. Note: We will perform a DNS check prior to signing the message to ensure the public keys matches the secondary DKIM."},"children":[]}]}]}]},"o:deliverytime":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the scheduled delivery time in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/api-overview#date-format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC-2822 format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Depending on your plan, you can schedule messages up to 3 or 7 days in advance. If your domain has a custom message_ttl (time-to-live) setting, this value determines the maximum scheduling duration. Example: 'Fri, 14 Oct 2011 12:00:00 +0000'"},"children":[]}]}]}]},"o:deliver-within":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the maximum time window for delivering the message. Accepts values in format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[0-9]+h[0-9]+m"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1h30m"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"30m"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), with a minimum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5m"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and maximum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For scheduled messages, the delivery window starts from the scheduled time. The standard retry schedule applies within this window, so shorter timeframes may result in fewer delivery attempts."},"children":[]}]}]}]},"o:deliverytime-optimize-period":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Toggles Send Time Optimization (STO) on a per-message basis.  String should be set to the number of hours in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[0-9]+h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format, with the minimum being "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the maximum being "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"72h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  This value defines the time window in which Mailgun will run the optimization algorithm based on prior engagement data of a given recipient.  See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/send-sto"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sending a Message with STO"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details. "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that STO is only available on certain plans. See www.mailgun.com/pricing for more info"},"children":[]}]}]}]}]},"o:time-zone-localize":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Toggles Timezone Optimization (TZO) on a per message basis. String should be set to preferred delivery time in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:mm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hh:mmaa"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:mm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used for 24 hour format without AM/PM and hh:mmaa is used for 12 hour format with AM/PM. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/send-tzo"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sending a Message with TZO"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details.  "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that TZO is only available on certain plans. See www.mailgun.com/pricing for more info"},"children":[]}]}]}]}]},"o:testmode":{"type":"string","enum":["yes"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enables sending in test mode. Messages are processed normally but not actually delivered to recipients. Useful for testing without sending real emails. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/test-mode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sending in Test Mode"},"children":[]}]}]}]}],"x-enumDescriptions":{"yes":"Send in test mode"}},"o:tracking":{"type":"string","enum":["yes","no","true","false","htmlonly"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Toggles both click and open tracking on a per-message basis, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/tracking-messages"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking Messages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}],"x-enumDescriptions":{"yes":"Enable tracking on a per-message basis","no":"Disable tracking on a per-message basis","true":"Enable tracking on a per-message basis","false":"Disable tracking on a per-message basis","htmlonly":"Use if you only want links rewritten in the HTML part of the message"}},"o:tracking-clicks":{"type":"string","enum":["yes","no","true","false","htmlonly"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Toggles click tracking on a per-message basis, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/tracking-messages/tracking-clicks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking Clicks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  This overrides the domain-level click tracking setting"},"children":[]}]}]}],"x-enumDescriptions":{"yes":"Enable tracking on a per-message basis","no":"Disable tracking on a per-message basis","true":"Enable tracking on a per-message basis","false":"Disable tracking on a per-message basis","htmlonly":"Use if you only want links rewritten in the HTML part of the message"}},"o:tracking-opens":{"type":"string","enum":["yes","no","true","false"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Toggles opens tracking on a per-message basis, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/tracking-messages/tracking-opens"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking Opens"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Has higher priority than domain-level setting."},"children":[]}]}]}],"x-enumDescriptions":{"yes":"Enables opens tracking","no":"Disable opens tracking","true":"Enables opens tracking","false":"Disable opens tracking"}},"o:require-tls":{"type":"string","enum":["yes","no","true","false"],"description":"When set to 'yes', requires the message to be sent only over a TLS connection. If TLS cannot be established, the message will not be delivered. When set to 'no' (default), Mailgun attempts TLS but falls back to plaintext SMTP if needed.","x-enumDescriptions":{"yes":"Message only be sent over a TLS connection","no":"Message do not require to be sent over a TLS connection","true":"Message only be sent over a TLS connection","false":"Message do not require to be sent over a TLS connection"}},"o:skip-verification":{"type":"string","enum":["yes","no","true","false"],"description":"When set to 'true', skips certificate and hostname verification for TLS connections. When 'false' (default), Mailgun verifies certificates and hostnames - if verification fails, TLS connection is not established.","x-enumDescriptions":{"yes":"Verification skipped","no":"Verification active","true":"Verification skipped","false":"Verification active"}},"o:sending-ip":{"type":"string","description":"Used to specify an IP Address to send an email that is owned by your account"},"o:sending-ip-pool":{"type":"string","description":"If an IP Pool ID is provided, the email will be delivered with an IP that belongs in that pool"},"o:tracking-pixel-location-top":{"type":"string","enum":["yes","no","true","false","htmlonly"],"description":"Places the tracking pixel at the top of emails instead of the bottom. Useful for long emails that may be truncated or have rendering issues, ensuring open tracking works accurately.","x-enumDescriptions":{"yes":"Enables tracking","no":"Disable tracking","true":"Enables tracking","false":"Disable tracking","htmlonly":"Use if you only want links rewritten in the HTML part of the message"}},"o:archive-to":{"type":"string","description":"Sends a copy of successfully delivered messages to the specified URL via HTTP POST. The request uses Content-Type: application/mime and contains the exact message the recipient's SMTP server received. NOTE: These are accounted for and billed as delivered messages"},"o:suppress-headers":{"type":"string","description":"Removes specified X-Mailgun headers from the delivered message. Provide header names separated by commas (e.g., 'X-Mailgun-Variables,X-Mailgun-Tag') or use 'all' to remove all X-Mailgun headers.Note: X-Mailgun-Sid header is currently used to process complains received via feedback loops."},"o:inbox-placement-test-key":{"type":"string","description":"Triggers an Inbox Placement test for this message using the provided value as an idempotency key. Retried or duplicate send requests that use the same key will not create additional tests. Requires Inbox Placement to be enabled for your account."},"h:X-My-Header":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds custom headers to the email. Use 'h:' prefix followed by header name and value. Example: 'h:X-Custom-Header=my-value'"},"children":[]}]}]}]},"v:my-var":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attaches custom data to the message using the 'v:' prefix followed by a variable name. When sending with templates, provides values for template variable substitution (overridden by 't:variables' if both are provided). When not using templates, treated as metadata and included in events/webhooks. Variables are visible in the delivered email's X-Mailgun-Variables header. Example: 'v:user-id=123'.NOTE: Anything over 4KB will be truncated in the event/webhooks"},"children":[]}]}]}]},"recipient-variables":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A JSON-encoded dictionary for batch sending with personalized variables per recipient. Each key is a recipient email address, each value is a dictionary of variables for that recipient. Variables can be referenced in the message using %recipient.variablename%. Example: '{\"alice@example.com\": {\"name\":\"Alice\", \"id\":1}, \"bob@example.com\": {\"name\":\"Bob\", \"id\":2}}'. Maximum 1,000 recipients per batch. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/batch-sending"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Batch Sending"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"required":["to","message"],"additionalProperties":true}},"components/schemas/POST-v3-domains-domain_name-messages-storage_key-multipart-form-data-RequestBody":{"id":"components/schemas/POST-v3-domains-domain_name-messages-storage_key-multipart-form-data-RequestBody","kind":"json-schema","title":"POST-v3-domains-domain_name-messages-storage_key-multipart-form-data-RequestBody","data":{"type":"object","properties":{"to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email address of the recipient(s). Supports friendly name format. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Bob <bob@host.com>\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use commas to separate multiple recipients. Duplicate addresses are automatically ignored."},"children":[]}]}]}]}},"required":["to"]}},"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseBasicExample":{"id":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseBasicExample","kind":"json-schema","title":"github.com-mailgun-influx-httpapi-GetMessageResponseBasicExample","data":{"type":"object","properties":{"Content-Transfer-Encoding":{"type":"string","description":"The content transfer encoding if enabled"},"Content-Type":{"type":"string","description":"The content type sent with the message with a possible boundary"},"From":{"type":"string","description":"The full 'From' email address entry of the email"},"Message-Id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the message as defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc2392"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC-2392"},"children":[]}]}]}]}]},"Mime-Version":{"type":"string","description":"The MIME version of the email"},"Subject":{"type":"string","description":"Subject of the email"},"To":{"type":"string","description":"The full 'To' email address entries"},"X-Mailgun-Tag":{"type":"string","description":"The raw tags of the message if provided"},"sender":{"type":"string","description":"Just the email address from the provided 'From'' field"},"recipients":{"type":"string","description":"A list of email addresses from the 'To'' field"},"body-html":{"type":"string","description":"The full HTML body of the full message"},"body-plain":{"type":"string","description":"The plain text body of the full message"},"stripped-html":{"type":"string","description":"Only the body of the email in HTML"},"stripped-text":{"type":"string","description":"Only the body of the email in plain text"},"stripped-signature":{"type":"string","description":"The signature stripped from the body"},"message-headers":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The full list of headers of the MIME upon send"},"X-Mailgun-Template-Name":{"type":"string","description":"The name of the template if one was used"},"X-Mailgun-Template-Variables":{"type":"string","description":"The variables used in the template if one was used"}},"required":["Content-Transfer-Encoding","Content-Type","From","Message-Id","Mime-Version","Subject","To","X-Mailgun-Tag","sender","recipients","body-html","body-plain","stripped-html","stripped-text","stripped-signature","message-headers","X-Mailgun-Template-Name","X-Mailgun-Template-Variables"]}},"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseBadRequest":{"id":"components/schemas/github.com-mailgun-influx-httpapi-GetMessageResponseBadRequest","kind":"json-schema","title":"github.com-mailgun-influx-httpapi-GetMessageResponseBadRequest","data":{"type":"object","properties":{"message":{"type":"string","description":"A failure message"}},"required":["message"]}},"components/schemas/github.com-mailgun-domains-client-golang-Disabled":{"id":"components/schemas/github.com-mailgun-domains-client-golang-Disabled","kind":"json-schema","title":"github.com-mailgun-domains-client-golang-Disabled","data":{"type":"object","properties":{"code":{"type":"string","description":"Code indicating the reason for the domain being disabled"},"note":{"type":"string","description":"Additional information about why the domain was disabled"},"permanently":{"type":"boolean","description":"Indicates whether the domain is permanently disabled"},"reason":{"type":"string","description":"Additional information about why the domain was disabled"},"until":{"type":"string","description":"Timestamp in RFC1123 format indicating when the domain will be re-enabled if the disablement is temporary"}},"required":["code","note","permanently","reason"]}},"components/schemas/github.com-mailgun-domains-client-golang-Domain":{"id":"components/schemas/github.com-mailgun-domains-client-golang-Domain","kind":"json-schema","title":"github.com-mailgun-domains-client-golang-Domain","data":{"type":"object","properties":{"archive_to":{"type":"string","description":"URL that a copy of each successfully delivered message is going to be posted to."},"created_at":{"type":"string","description":"Timestamp indicating when the domain was created in RFC1123 format"},"id":{"type":"string","description":"Unique identifier of the domain"},"is_disabled":{"type":"boolean","description":"Indicates whether the domain is currently disabled"},"name":{"type":"string","description":"Fully qualified domain name registered with Mailgun"},"require_tls":{"type":"boolean","description":"If true Mailgun will only send messages over a TLS connection"},"skip_verification":{"type":"boolean","description":"If true Mailgun will not verify the certificate and hostname when setting up a TLS connection"},"smtp_login":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP login username for the domain, only present if the user provides an smtp_password. Use the Credentials API for SMTP credentials management"},"children":[]}]}]}]},"smtp_password":{"type":"string","description":"Optional SMTP password for the domain used for SMTP authentication"},"spam_action":{"type":"string","description":"Action to take when a message is flagged as spam. Options are disabled, tag, or block"},"subaccount_id":{"type":"string","description":"The subaccount ID the domain belongs to. This field is only present if the domain is associated with a subaccount"},"state":{"type":"string","description":"Current verification status of the domain"},"type":{"type":"string","description":"Classification of the domain. Possible values are custom or sandbox"},"tracking_host":{"type":"string","description":"Custom tracking host for the domain used for tracking opens and clicks if configured"},"use_automatic_sender_security":{"type":"boolean","description":"If true Mailgun manages DKIM key generation and DNS record configuration automatically"},"webhooks_redact_pii":{"type":"boolean","description":"If true Personally Identifiable Information (PII) will be redacted from the payload of any webhook posted for this domain"},"web_prefix":{"type":"string","description":"Subdomain prefix used for open and click tracking"},"web_scheme":{"type":"string","description":"Protocol scheme used for tracking"},"wildcard":{"type":"boolean","description":"Indicates if the domain is a wildcard domain and can receive emails for any subdomain"},"disabled":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-client-golang-Disabled"},{"type":"null"}],"description":"Optional field containing additional details about the domain's disabled status if applicable"},"encrypt_incoming_message":{"type":"boolean","description":"If true incoming messages to this domain will be encrypted"},"message_ttl":{"type":"integer","format":"int32","description":"Specifies the time-to-live (TTL) in seconds for retrieving both incoming and outgoing messages. The maximum TTL value is determined by your subscription plan"}},"required":["created_at","id","is_disabled","name","require_tls","skip_verification","smtp_login","spam_action","state","type","use_automatic_sender_security","web_prefix","web_scheme","wildcard","encrypt_incoming_message","message_ttl"]}},"components/schemas/github.com-mailgun-domains-client-golang-Record":{"id":"components/schemas/github.com-mailgun-domains-client-golang-Record","kind":"json-schema","title":"github.com-mailgun-domains-client-golang-Record","data":{"type":"object","properties":{"is_active":{"type":"boolean","description":"Indicates whether the DNS record is currently active"},"cached":{"type":"array","items":{"type":"string"},"description":"List of Mailguns cached values for the DNS record"},"name":{"type":"string","description":"Name of the DNS record if applicable"},"priority":{"type":"string","description":"Priority value for MX DNS records"},"record_type":{"type":"string","description":"Type of DNS record such as MX TXT or CNAME"},"valid":{"type":"string","description":"Indicates whether the DNS record is valid"},"value":{"type":"string","description":"Expected value of the DNS record"}},"required":["is_active","cached","record_type","valid","value"]}},"components/schemas/github.com-mailgun-domains-httpapi-CreateDomainResp":{"id":"components/schemas/github.com-mailgun-domains-httpapi-CreateDomainResp","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-CreateDomainResp","data":{"type":"object","properties":{"message":{"type":"string","description":"Response message"},"domain":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-client-golang-Domain"},{"type":"null"}],"description":"Details of the newly created domain"},"receiving_dns_records":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-client-golang-Record"},{"type":"null"}]},"description":"List of DNS records required for receiving emails"},"sending_dns_records":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-client-golang-Record"},{"type":"null"}]},"description":"List of DNS records required for sending emails"}},"required":["message","domain","receiving_dns_records","sending_dns_records"]}},"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse":{"id":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","kind":"json-schema","title":"github.com-mailgun-scaffold-httpapi-GenericResponse","data":{"type":"object","properties":{"message":{"type":"string","description":"Response message"}},"required":["message"]}},"components/schemas/POST-v4-domains-multipart-form-data-RequestBody":{"id":"components/schemas/POST-v4-domains-multipart-form-data-RequestBody","kind":"json-schema","title":"POST-v4-domains-multipart-form-data-RequestBody","data":{"type":"object","properties":{"archive_to":{"type":"string","description":"If set to a URL, then each successfully delivered message will be submitted in an HTTP POST request to the URL. The Content-Type of the POST requests is application/mime and the request body is exactly what the recipient SMTP server received."},"dkim_host_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set the DKIM host name for the domain that is being created. Note, the value must be a valid domain name, and can be the domain name being created or the root domain. This parameter cannot be used in conjunction with force_dkim_authority or force_root_dkim_host."},"children":[]}]}]}]},"dkim_key_size":{"type":"string","description":"The size of the new domain's DKIM key. Shall be either 1024 or 2048."},"dkim_selector":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explicitly set the value of the DKIM selector for the domain being created. If the domain key does not already exist, one will be created.  The selector must be a valid atom per RFC2822. e.g valid value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"foobar"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", invalid value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"foo.bar"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://datatracker.ietf.org/doc/html/rfc2822#section-3.2.4"},"children":[]}]}]}]},"encrypt_incoming_message":{"type":"boolean","description":"Enable encrypting incoming messages for the given domain. This cannot be altered via API after being set for security purposes. Reach out to Support to disable if necessary. Default to false"},"force_dkim_authority":{"type":"boolean","description":"If set to true, the domain will be the DKIM authority for itself even if the root domain is registered on the same mailgun account. If set to false, the domain will have the same DKIM authority as the root domain registered on the same mailgun account. Default to false."},"force_root_dkim_host":{"type":"boolean","description":"If set to true, the root domain will be the DKIM Host for the domain being created even if the root domain itself is not registered with Mailgun. The domain being created will still need to pass domain verification with valid spf records for the domain and valid DKIM record for the root domain.  This does not effect the smtp mail-from host for the domain being created. The mail-from host will remain the domain name being created, not the root domain."},"wildcard":{"type":"boolean","description":"Allows domain to accept inbound messages received on subdomains that have MX records pointed to Mailgun. Default is false."},"name":{"type":"string","description":"The name of the new domain"},"pool_id":{"type":"string","description":"Requested IP Pool to be assigned to the domain at creation."},"ips":{"type":"string","description":"An optional, comma-separated list of IP addresses to be assigned to this domain. If not specified, all dedicated IP addresses on the account will be assigned. If the request cannot be fulfilled (e.g. a requested IP is not assigned to the account, etc), a 400 will be returned."},"require_tls":{"type":"boolean","description":"If set to true, this requires messages for the domain only be sent over a TLS connection. If a TLS connection cannot be established, Mailgun will not deliver the message.\n\nIf set to false, Mailgun will still try and upgrade the connection, but if Mailgun cannot, the message will be delivered over a plaintext SMTP connection.\n\nThe default value is false."},"skip_verification":{"type":"boolean","description":"If set to true, the certificate and hostname will not be verified when trying to establish a TLS connection and Mailgun will accept any certificate during delivery of a message.\n\nIf set to false, Mailgun will verify the certificate and hostname. If either one can not be verified, a TLS connection will not be established.\n\nThe default value is false."},"spam_action":{"type":"string","description":"Disabled, block or tag. Default to disabled. If disabled, no spam filtering will occur for inbound messages.\n\nIf block, inbound spam messages will not be delivered.\n\nIf tag, inbound messages will be tagged with a spam header. See Spam Filter."},"smtp_password":{"type":"string","description":"Password for SMTP authentication"},"use_automatic_sender_security":{"type":"boolean","description":"Enable Automatic Sender Security. This requires setting DNS CNAME entries for DKIM keys instead of a TXT record. Defaults to false."},"webhooks_redact_pii":{"type":"boolean","description":"If set to true, Personally Identifiable Information (PII) will be redacted from the payload of any webhook posted for this domain"},"web_prefix":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets your open, click and unsubscribe URLs domain name prefix. Links rewritten or added by Mailgun in your emails will look like <web_scheme>://<web_prefix>.<domain_name>/... Default to email"},"children":[]}]}]}]},"web_scheme":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets your open, click and unsubscribe URLs to use http or https. Value either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"http"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to http. In order for https to work, you must have a valid cert created for your domain. See Domain Tracking for TLS cert generation."},"children":[]}]}]}]},"message_ttl":{"type":"integer","description":"Specifies the time-to-live (TTL) in seconds for retrieving both incoming and outgoing messages. The maximum TTL value is determined by your subscription plan."}},"required":["name"]}},"components/schemas/github.com-mailgun-domains-httpapi-ListDomainResponse":{"id":"components/schemas/github.com-mailgun-domains-httpapi-ListDomainResponse","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-ListDomainResponse","data":{"type":"object","properties":{"total_count":{"type":"integer","format":"int32","description":"Total number of domains"},"items":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-domains-client-golang-Domain"},"description":"List of domains"}},"required":["total_count","items"]}},"components/schemas/github.com-mailgun-domains-httpapi-FindDomainByNameResp":{"id":"components/schemas/github.com-mailgun-domains-httpapi-FindDomainByNameResp","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-FindDomainByNameResp","data":{"type":"object","properties":{"domain":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-client-golang-Domain"},{"type":"null"}],"description":"Domain details"},"receiving_dns_records":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-client-golang-Record"},{"type":"null"}]},"description":"List of DNS records required for receiving emails"},"sending_dns_records":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-client-golang-Record"},{"type":"null"}]},"description":"List of DNS records required for sending emails"}},"required":["domain"]}},"components/schemas/github.com-mailgun-domains-httpapi-VerifyDomainResponse":{"id":"components/schemas/github.com-mailgun-domains-httpapi-VerifyDomainResponse","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-VerifyDomainResponse","data":{"type":"object","properties":{"message":{"type":"string","description":"Response message"},"domain":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-client-golang-Domain"},{"type":"null"}],"description":"Domain record information"},"sending_dns_records":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-client-golang-Record"},{"type":"null"}]},"description":"List of DNS records required for sending emails"},"receiving_dns_records":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-client-golang-Record"},{"type":"null"}]},"description":"List of DNS records required for receiving emails"}},"required":["message","domain","sending_dns_records","receiving_dns_records"]}},"components/schemas/github.com-mailgun-domains-httpapi-WebhookResponse":{"id":"components/schemas/github.com-mailgun-domains-httpapi-WebhookResponse","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-WebhookResponse","data":{"type":"object","properties":{"urls":{"type":"array","items":{"type":"string"},"description":"List of webhooks"}}}},"components/schemas/github.com-mailgun-domains-httpapi-CreateDomainWebhookResp":{"id":"components/schemas/github.com-mailgun-domains-httpapi-CreateDomainWebhookResp","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-CreateDomainWebhookResp","data":{"type":"object","properties":{"message":{"type":"string","description":"A message indicating success"},"webhook":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-httpapi-WebhookResponse"}],"description":"Webhook details"}},"required":["message","webhook"]}},"components/schemas/POST-v3-domains-domain-webhooks-multipart-form-data-RequestBody":{"id":"components/schemas/POST-v3-domains-domain-webhooks-multipart-form-data-RequestBody","kind":"json-schema","title":"POST-v3-domains-domain-webhooks-multipart-form-data-RequestBody","data":{"type":"object","properties":{"id":{"type":"string","enum":["accepted","clicked","opened","unsubscribed","delivered","permanent_fail","temporary_fail","complained"],"description":"Webhook type to create.","x-enumDescriptions":{"accepted":"The accepted event occurs when Mailgun accepts a message for delivery.","clicked":"The clicked event occurs when a recipient clicks a link in the email. This requires click tracking to be enabled for the domain.","opened":"The opened event occurs when a recipient opens the email. This requires open tracking to be enabled for the domain.","unsubscribed":"The unsubscribed event occurs when a recipient unsubscribes using an unsubscribe mechanism in your email (for example, a list-unsubscribe link).","delivered":"The delivered event occurs when an email is successfully delivered to the recipient's mail server.","permanent_fail":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The permanent_fail event occurs when an email cannot be delivered due to a permanent error."},"children":[]}]}]}],"temporary_fail":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary_fail event occurs when an email cannot be delivered due to a temporary error."},"children":[]}]}]}],"complained":"The complained event occurs when a recipient marks your email as spam or their email provider registers a spam complaint."}},"url":{"type":"string","description":"url(s) for webhooks to be sent to. Use multiple times to associate more than one url. Maximum of 3 urls for a given webhook type."}},"required":["id","url"]}},"components/schemas/PUT-v3-domains-domain_name-webhooks-webhook_name-multipart-form-data-RequestBody":{"id":"components/schemas/PUT-v3-domains-domain_name-webhooks-webhook_name-multipart-form-data-RequestBody","kind":"json-schema","title":"PUT-v3-domains-domain_name-webhooks-webhook_name-multipart-form-data-RequestBody","data":{"type":"object","properties":{"url":{"type":"string","description":"New url(s) to associate to webhook. Use multiple times to associate more than one url. Maximum of 3 urls for a given type."}},"required":["url"]}},"components/schemas/github.com-mailgun-domains-httpapi-GetDomainWebhookResp":{"id":"components/schemas/github.com-mailgun-domains-httpapi-GetDomainWebhookResp","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-GetDomainWebhookResp","data":{"type":"object","properties":{"webhook":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-httpapi-WebhookResponse"}],"description":"List of webhooks"}},"required":["webhook"]}},"components/schemas/github.com-mailgun-domains-httpapi-WebhookURLs":{"id":"components/schemas/github.com-mailgun-domains-httpapi-WebhookURLs","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-WebhookURLs","data":{"type":"object","properties":{"urls":{"type":"array","items":{"type":"string"},"description":"List of URLs"}},"required":["urls"]}},"components/schemas/github.com-mailgun-domains-httpapi-WebhooksResponse":{"id":"components/schemas/github.com-mailgun-domains-httpapi-WebhooksResponse","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-WebhooksResponse","data":{"type":"object","properties":{"accepted":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-httpapi-WebhookURLs"},{"type":"null"}],"description":"Accepted webhook URLs"},"delivered":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-httpapi-WebhookURLs"},{"type":"null"}],"description":"Delivered webhook URLs"},"opened":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-httpapi-WebhookURLs"},{"type":"null"}],"description":"Opened webhook URLs"},"clicked":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-httpapi-WebhookURLs"},{"type":"null"}],"description":"Clicked webhook URLs"},"unsubscribed":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-httpapi-WebhookURLs"},{"type":"null"}],"description":"Unsubscribed webhook URLs"},"complained":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-httpapi-WebhookURLs"},{"type":"null"}],"description":"Complained webhook URLs"},"temporary_fail":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-httpapi-WebhookURLs"},{"type":"null"}],"description":"Temporary fail webhook URLs"},"permanent_fail":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-httpapi-WebhookURLs"},{"type":"null"}],"description":"Permanent fail webhook URLs"}}}},"components/schemas/github.com-mailgun-domains-httpapi-GetAllDomainWebhooksResp":{"id":"components/schemas/github.com-mailgun-domains-httpapi-GetAllDomainWebhooksResp","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-GetAllDomainWebhooksResp","data":{"type":"object","properties":{"webhooks":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-httpapi-WebhooksResponse"}],"description":"List of webhooks"}},"required":["webhooks"]}},"components/schemas/POST-v4-domains-domain-webhooks-application-x-www-form-urlencoded-RequestBody":{"id":"components/schemas/POST-v4-domains-domain-webhooks-application-x-www-form-urlencoded-RequestBody","kind":"json-schema","title":"POST-v4-domains-domain-webhooks-application-x-www-form-urlencoded-RequestBody","data":{"type":"object","properties":{"url":{"type":"string","description":"The webhook URL that will receive POST requests"},"event_types":{"type":"string","enum":["accepted","clicked","opened","unsubscribed","delivered","permanent_fail","temporary_fail","complained"],"description":"Event types. Use multiple times to specify multiple event types. ","x-enumDescriptions":{"accepted":"The accepted event occurs when Mailgun accepts a message for delivery.","clicked":"The clicked event occurs when a recipient clicks a link in the email. This requires click tracking to be enabled for the domain.","opened":"The opened event occurs when a recipient opens the email. This requires open tracking to be enabled for the domain.","unsubscribed":"The unsubscribed event occurs when a recipient unsubscribes using an unsubscribe mechanism in your email (for example, a list-unsubscribe link).","delivered":"The delivered event occurs when an email is successfully delivered to the recipient's mail server.","permanent_fail":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The permanent_fail event occurs when an email cannot be delivered due to a permanent error."},"children":[]}]}]}],"temporary_fail":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary_fail event occurs when an email cannot be delivered due to a temporary error."},"children":[]}]}]}],"complained":"The complained event occurs when a recipient marks your email as spam or their email provider registers a spam complaint."}}},"required":["url","event_types"]}},"components/schemas/PUT-v4-domains-domain-webhooks-application-x-www-form-urlencoded-RequestBody":{"id":"components/schemas/PUT-v4-domains-domain-webhooks-application-x-www-form-urlencoded-RequestBody","kind":"json-schema","title":"PUT-v4-domains-domain-webhooks-application-x-www-form-urlencoded-RequestBody","data":{"type":"object","properties":{"url":{"type":"string","description":"The webhook URL to update"},"event_types":{"type":"string","enum":["accepted","clicked","opened","unsubscribed","delivered","permanent_fail","temporary_fail","complained"],"description":"Event types to associate with this URL. Use multiple times to specify multiple event types. This replaces the existing associations. ","x-enumDescriptions":{"accepted":"The accepted event occurs when Mailgun accepts a message for delivery.","clicked":"The clicked event occurs when a recipient clicks a link in the email. This requires click tracking to be enabled for the domain.","opened":"The opened event occurs when a recipient opens the email. This requires open tracking to be enabled for the domain.","unsubscribed":"The unsubscribed event occurs when a recipient unsubscribes using an unsubscribe mechanism in your email (for example, a list-unsubscribe link).","delivered":"The delivered event occurs when an email is successfully delivered to the recipient's mail server.","permanent_fail":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The permanent_fail event occurs when an email cannot be delivered due to a permanent error."},"children":[]}]}]}],"temporary_fail":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary_fail event occurs when an email cannot be delivered due to a temporary error."},"children":[]}]}]}],"complained":"The complained event occurs when a recipient marks your email as spam or their email provider registers a spam complaint."}}},"required":["url","event_types"]}},"components/schemas/github.com-mailgun-domains-httpapi-openSettings":{"id":"components/schemas/github.com-mailgun-domains-httpapi-openSettings","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-openSettings","data":{"type":"object","properties":{"active":{"type":"boolean","description":"Whether open tracking is enabled or not"},"place_at_the_top":{"type":"boolean","description":"If the pixel should be placed at the top of the email"}},"required":["active","place_at_the_top"]}},"components/schemas/github.com-mailgun-domains-httpapi-clickSettings":{"id":"components/schemas/github.com-mailgun-domains-httpapi-clickSettings","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-clickSettings","data":{"type":"object","properties":{"active":{"type":"boolean","description":"Whether click tracking is enabled or not"}},"required":["active"]}},"components/schemas/github.com-mailgun-domains-httpapi-unsubscribeSettings":{"id":"components/schemas/github.com-mailgun-domains-httpapi-unsubscribeSettings","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-unsubscribeSettings","data":{"type":"object","properties":{"active":{"type":"boolean","description":"Whether unsubscribe tracking is enabled or not"},"html_footer":{"type":"string","description":"The HTML footer for the unsubscribe link"},"text_footer":{"type":"string","description":"The text footer for the unsubscribe link"}},"required":["active","html_footer","text_footer"]}},"components/schemas/github.com-mailgun-domains-httpapi-trackingSettings":{"id":"components/schemas/github.com-mailgun-domains-httpapi-trackingSettings","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-trackingSettings","data":{"type":"object","properties":{"open":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-httpapi-openSettings"}],"description":"Open tracking settings"},"click":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-httpapi-clickSettings"}],"description":"Click tracking settings"},"unsubscribe":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-httpapi-unsubscribeSettings"}],"description":"Unsubscribe tracking settings"},"web_scheme":{"type":"string","description":"The web scheme for the domain"}},"required":["open","click","unsubscribe","web_scheme"]}},"components/schemas/github.com-mailgun-domains-httpapi-GetDomainTrackingResp":{"id":"components/schemas/github.com-mailgun-domains-httpapi-GetDomainTrackingResp","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-GetDomainTrackingResp","data":{"type":"object","properties":{"tracking":{"$ref":"#/components/schemas/github.com-mailgun-domains-httpapi-trackingSettings"}},"required":["tracking"]}},"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainTrackingClickResp":{"id":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainTrackingClickResp","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-UpdateDomainTrackingClickResp","data":{"type":"object","properties":{"message":{"type":"string","description":"A message indicating success"},"click":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-httpapi-clickSettings"}],"description":"Click settings"}},"required":["message","click"]}},"components/schemas/PUT-v3-domains-name-tracking-click-multipart-form-data-RequestBody":{"id":"components/schemas/PUT-v3-domains-name-tracking-click-multipart-form-data-RequestBody","kind":"json-schema","title":"PUT-v3-domains-name-tracking-click-multipart-form-data-RequestBody","data":{"type":"object","properties":{"active":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set param to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"htmlonly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  Omit this param to make no change to the active status. Click tracking is consider as active if it's in the 'htmlonly' or 'true' state"},"children":[]}]}]}]}}}},"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainTrackingOpenResp":{"id":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainTrackingOpenResp","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-UpdateDomainTrackingOpenResp","data":{"type":"object","properties":{"message":{"type":"string","description":"A message indicating success"},"open":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-httpapi-openSettings"}],"description":"Open settings"}},"required":["message","open"]}},"components/schemas/PUT-v3-domains-name-tracking-open-multipart-form-data-RequestBody":{"id":"components/schemas/PUT-v3-domains-name-tracking-open-multipart-form-data-RequestBody","kind":"json-schema","title":"PUT-v3-domains-name-tracking-open-multipart-form-data-RequestBody","data":{"type":"object","properties":{"active":{"type":"boolean","description":"Set this param to true or false to toggle open tracking active status. Omit this param to keep current settings."},"place_at_the_top":{"type":"boolean","description":"Setting this param to true will place the open tracking pixel at the top of the HTML body when inserted into the email mime. Omit this param to keep current setting."}}}},"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainTrackingUnsubscribeResp":{"id":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainTrackingUnsubscribeResp","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-UpdateDomainTrackingUnsubscribeResp","data":{"type":"object","properties":{"message":{"type":"string","description":"A message indicating success"},"unsubscribe":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-httpapi-unsubscribeSettings"}],"description":"Unsubscribe settings"}},"required":["message","unsubscribe"]}},"components/schemas/PUT-v3-domains-name-tracking-unsubscribe-multipart-form-data-RequestBody":{"id":"components/schemas/PUT-v3-domains-name-tracking-unsubscribe-multipart-form-data-RequestBody","kind":"json-schema","title":"PUT-v3-domains-name-tracking-unsubscribe-multipart-form-data-RequestBody","data":{"type":"object","properties":{"active":{"type":"boolean","description":"This param will toggle the active status of unsubscribe tracking on the domain."},"html_footer":{"type":"string","description":"Updates the html footer for the unsubscribe link inserted into the email html part of the mime."},"text_footer":{"type":"string","description":"Updates the text footer for the unsubscribe link inserted into the email plain part of the mime."}}}},"components/schemas/github.com-mailgun-domains-httpapi-DomainKeyResponse":{"id":"components/schemas/github.com-mailgun-domains-httpapi-DomainKeyResponse","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-DomainKeyResponse","data":{"type":"object","properties":{"signing_domain":{"type":"string"},"selector":{"type":"string"},"dns_record":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-client-golang-Record"},{"type":"null"}]}},"required":["signing_domain","selector"]}},"components/schemas/POST-v1-dkim-keys-multipart-form-data-RequestBody":{"id":"components/schemas/POST-v1-dkim-keys-multipart-form-data-RequestBody","kind":"json-schema","title":"POST-v1-dkim-keys-multipart-form-data-RequestBody","data":{"type":"object","properties":{"signing_domain":{"type":"string","description":"Signing domain to be used for the new domain key"},"selector":{"type":"string","description":"Selector to be used for the new domain key"},"bits":{"type":"integer","description":"Key size, can be 1024 or 2048"},"pem":{"type":"string","description":"Private key PEM file"}},"required":["signing_domain","selector"]}},"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainKeyResp":{"id":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainKeyResp","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-UpdateDomainKeyResp","data":{"type":"object","properties":{"message":{"type":"string"},"authority":{"type":"string"},"selector":{"type":"string"},"active":{"type":"boolean"}},"required":["message","authority","selector","active"]}},"components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingResponse":{"id":"components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingResponse","kind":"json-schema","title":"github.com-mailgun-scaffold-httpapi-paging-PagingResponse","data":{"type":"object","properties":{"previous":{"type":"string","description":"Previous page URL"},"first":{"type":"string","description":"First page URL"},"next":{"type":"string","description":"Next page URL"},"last":{"type":"string","description":"Last page URL"}},"required":["previous","first","next","last"]}},"components/schemas/github.com-mailgun-domains-httpapi-DomainKeyListResponse":{"id":"components/schemas/github.com-mailgun-domains-httpapi-DomainKeyListResponse","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-DomainKeyListResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-httpapi-DomainKeyResponse"},{"type":"null"}]}},"paging":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingResponse"},{"type":"null"}]}},"required":["items"]}},"components/schemas/GET-v1-dkim-keys-multipart-form-data-RequestBody":{"id":"components/schemas/GET-v1-dkim-keys-multipart-form-data-RequestBody","kind":"json-schema","title":"GET-v1-dkim-keys-multipart-form-data-RequestBody","data":{"type":"object","properties":{"page":{"type":"string","description":"Encoded paging information, provided via 'next', 'previous' links"},"limit":{"type":"integer","description":"Limits the number of items returned in a request"},"signing_domain":{"type":"string","description":"Filter by signing domain"},"selector":{"type":"string","description":"Filter by selector"}},"required":["page","limit"]}},"components/schemas/github.com-mailgun-domains-httpapi-AuthorityKeysResponse":{"id":"components/schemas/github.com-mailgun-domains-httpapi-AuthorityKeysResponse","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-AuthorityKeysResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-httpapi-DomainKeyResponse"},{"type":"null"}]}}},"required":["items"]}},"components/schemas/github.com-mailgun-domains-httpapi-ReassignDkimAuthorityResp":{"id":"components/schemas/github.com-mailgun-domains-httpapi-ReassignDkimAuthorityResp","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-ReassignDkimAuthorityResp","data":{"type":"object","properties":{"message":{"type":"string"},"sending_dns_records":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-client-golang-Record"},{"type":"null"}]}},"changed":{"type":"boolean"}},"required":["message","sending_dns_records","changed"]}},"components/schemas/PUT-v3-domains-name-dkim_authority-multipart-form-data-RequestBody":{"id":"components/schemas/PUT-v3-domains-name-dkim_authority-multipart-form-data-RequestBody","kind":"json-schema","title":"PUT-v3-domains-name-dkim_authority-multipart-form-data-RequestBody","data":{"type":"object","properties":{"self":{"type":"boolean","description":"Change the DKIM authority for a domain.\nIf set to true, the domain will be the DKIM authority for itself even if the root domain is registered on the same mailgun account\n If set to false, the domain will have the same DKIM authority as the root domain registered on the same mailgun account."}}}},"components/schemas/PUT-v3-domains-name-dkim_selector-multipart-form-data-RequestBody":{"id":"components/schemas/PUT-v3-domains-name-dkim_selector-multipart-form-data-RequestBody","kind":"json-schema","title":"PUT-v3-domains-name-dkim_selector-multipart-form-data-RequestBody","data":{"type":"object","properties":{"dkim_selector":{"type":"string","description":"Update the DKIM selector for a domain. If omitted no change is committed."}}}},"components/schemas/github.com-mailgun-domains-httpapi-CreateAccountLevelWebhookResp":{"id":"components/schemas/github.com-mailgun-domains-httpapi-CreateAccountLevelWebhookResp","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-CreateAccountLevelWebhookResp","data":{"type":"object","properties":{"webhook_id":{"type":"string","description":"Unique identifier for the webhook"}},"required":["webhook_id"]}},"components/schemas/POST-v1-webhooks-multipart-form-data-RequestBody":{"id":"components/schemas/POST-v1-webhooks-multipart-form-data-RequestBody","kind":"json-schema","title":"POST-v1-webhooks-multipart-form-data-RequestBody","data":{"type":"object","properties":{"description":{"type":"string","description":"Description for the webhook"},"event_types":{"type":"string","enum":["accepted","clicked","opened","unsubscribed","delivered","permanent_fail","temporary_fail","complained"],"description":"Event types to subscribe to. Use multiple times to specify multiple event types. Maximum of 3 unique URLs per event type.","x-enumDescriptions":{"accepted":"The accepted event occurs when Mailgun accepts a message for delivery.","clicked":"The clicked event occurs when a recipient clicks a link in the email. This requires click tracking to be enabled for the domain.","opened":"The opened event occurs when a recipient opens the email. This requires open tracking to be enabled for the domain.","unsubscribed":"The unsubscribed event occurs when a recipient unsubscribes using an unsubscribe mechanism in your email (for example, a list-unsubscribe link).","delivered":"The delivered event occurs when an email is successfully delivered to the recipient's mail server.","permanent_fail":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The permanent_fail event occurs when an email cannot be delivered due to a permanent error."},"children":[]}]}]}],"temporary_fail":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary_fail event occurs when an email cannot be delivered due to a temporary error."},"children":[]}]}]}],"complained":"The complained event occurs when a recipient marks your email as spam or their email provider registers a spam complaint."}},"url":{"type":"string","description":"URL for webhook to be sent to"}},"required":["event_types","url"]}},"components/schemas/github.com-mailgun-domains-httpapi-AccountLevelWebhookView":{"id":"components/schemas/github.com-mailgun-domains-httpapi-AccountLevelWebhookView","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-AccountLevelWebhookView","data":{"type":"object","properties":{"webhook_id":{"type":"string","description":"Unique identifier for the webhook"},"description":{"type":"string","description":"User-provided description of the webhook"},"url":{"type":"string","description":"The endpoint URL where webhook events are delivered"},"event_types":{"type":"array","items":{"type":"string"},"description":"List of event types that trigger this webhook"},"created_at":{"type":"string","format":"date-time","description":"Timestamp indicating when the webhook was created in RFC3339 format"}},"required":["webhook_id","description","url","event_types","created_at"]}},"components/schemas/github.com-mailgun-domains-httpapi-AccountLevelWebhooksResp":{"id":"components/schemas/github.com-mailgun-domains-httpapi-AccountLevelWebhooksResp","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-AccountLevelWebhooksResp","data":{"type":"object","properties":{"webhooks":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-domains-httpapi-AccountLevelWebhookView"}}},"required":["webhooks"]}},"components/schemas/PUT-v1-webhooks-webhook_id-multipart-form-data-RequestBody":{"id":"components/schemas/PUT-v1-webhooks-webhook_id-multipart-form-data-RequestBody","kind":"json-schema","title":"PUT-v1-webhooks-webhook_id-multipart-form-data-RequestBody","data":{"type":"object","properties":{"description":{"type":"string","description":"Description for the webhook"},"event_types":{"type":"string","enum":["accepted","clicked","opened","unsubscribed","delivered","permanent_fail","temporary_fail","complained"],"description":"Event types to subscribe to. Use multiple times to specify multiple event types. Maximum of 3 unique URLs per event type.","x-enumDescriptions":{"accepted":"The accepted event occurs when Mailgun accepts a message for delivery.","clicked":"The clicked event occurs when a recipient clicks a link in the email. This requires click tracking to be enabled for the domain.","opened":"The opened event occurs when a recipient opens the email. This requires open tracking to be enabled for the domain.","unsubscribed":"The unsubscribed event occurs when a recipient unsubscribes using an unsubscribe mechanism in your email (for example, a list-unsubscribe link).","delivered":"The delivered event occurs when an email is successfully delivered to the recipient's mail server.","permanent_fail":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The permanent_fail event occurs when an email cannot be delivered due to a permanent error."},"children":[]}]}]}],"temporary_fail":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary_fail event occurs when an email cannot be delivered due to a temporary error."},"children":[]}]}]}],"complained":"The complained event occurs when a recipient marks your email as spam or their email provider registers a spam complaint."}},"url":{"type":"string","description":"URL for webhook to be sent to"}},"required":["event_types","url"]}},"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainResp":{"id":"components/schemas/github.com-mailgun-domains-httpapi-UpdateDomainResp","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-UpdateDomainResp","data":{"type":"object","properties":{"message":{"type":"string","description":"Success message"},"domain":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-client-golang-Domain"},{"type":"null"}],"description":"Domain object"},"receiving_dns_records":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-client-golang-Record"},{"type":"null"}]},"description":"List of DNS records required for receiving emails"},"sending_dns_records":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-client-golang-Record"},{"type":"null"}]},"description":" List of DNS records required for sending emails"}},"required":["message","domain"]}},"components/schemas/PUT-v4-domains-name-multipart-form-data-RequestBody":{"id":"components/schemas/PUT-v4-domains-name-multipart-form-data-RequestBody","kind":"json-schema","title":"PUT-v4-domains-name-multipart-form-data-RequestBody","data":{"type":"object","properties":{"archive_to":{"type":"string","description":"If set to a URL, then each successfully delivered message will be submitted in an HTTP POST request to the URL. The Content-Type of the POST requests is application/mime and the request body is exactly what the recipient SMTP server received."},"mailfrom_host":{"type":"string","description":"The hostname to update to. Must be in lower case"},"message_ttl":{"type":"integer","description":"Specifies the time-to-live (TTL) in seconds for retrieving both incoming and outgoing messages. The maximum TTL value is determined by your subscription plan."},"require_tls":{"type":"boolean","description":"If set to true, this requires messages for the domain only be sent over a TLS connection. If a TLS connection cannot be established, Mailgun will not deliver the message.\n\nIf set to false, Mailgun will still try and upgrade the connection, but if Mailgun cannot, the message will be delivered over a plaintext SMTP connection.\n\nThe default value is false."},"skip_verification":{"type":"boolean","description":"If set to true, the certificate and hostname will not be verified when trying to establish a TLS connection and Mailgun will accept any certificate during delivery of a message.\n\nIf set to false, Mailgun will verify the certificate and hostname. If either one can not be verified, a TLS connection will not be established.\n\nThe default value is false."},"smtp_password":{"type":"string","description":"Updates the domain's SMTP credentials with the given string"},"spam_action":{"type":"string","description":"Updates the domain's spam action. Valid values are 'disabled', 'tag', and 'block'"},"use_automatic_sender_security":{"type":"boolean","description":"Enable or disable Automatic Sender Security. If enabled, requires setting DNS CNAME entries for DKIM keys instead of a TXT record. Domain must be reverified after changing this field. Defaults to false"},"webhooks_redact_pii":{"type":"boolean","description":"If set to true, Personally Identifiable Information (PII) will be redacted from the payload of any webhook posted for this domain"},"web_scheme":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates your open, click and unsubscribe URLs to use http or https. Value either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"http"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to http. In order for https to work, you must have a valid cert created for your domain. See Domain Tracking for TLS cert generation."},"children":[]}]}]}]},"web_prefix":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This updates the web prefix used for a domain's tracking features.  Must be a valid atom. Nothing will be updated if omitted. This impacts click, open, and unsubscribe tracking features."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Updating the web prefix for a domain will require also updating the domain's DNS to include the CNAME record to match. For example, if you set the web prefix to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the domain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"my-domain.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the corresponding CNAME "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zed.my-domain.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will need to be created in your domain's dns zone."},"children":[]}]}]}]},"wildcard":{"type":"boolean","description":"Updates the domain's wildcard status with the given boolean"}}}},"components/schemas/github.com-mailgun-domains-httpapi-ExceededQueueQuotaDisabledJSON":{"id":"components/schemas/github.com-mailgun-domains-httpapi-ExceededQueueQuotaDisabledJSON","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-ExceededQueueQuotaDisabledJSON","data":{"type":"object","properties":{"until":{"type":"string","description":"End date in RFC-822 date format"},"reason":{"type":"string","description":"Cause description"}},"required":["until","reason"]}},"components/schemas/github.com-mailgun-domains-httpapi-ExceededQueueQuotaJSON":{"id":"components/schemas/github.com-mailgun-domains-httpapi-ExceededQueueQuotaJSON","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-ExceededQueueQuotaJSON","data":{"type":"object","properties":{"is_disabled":{"type":"boolean","description":"Flag indicating no new messages are able to be submitted"},"disabled":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-httpapi-ExceededQueueQuotaDisabledJSON"}],"description":"Disabled info"}},"required":["is_disabled"]}},"components/schemas/github.com-mailgun-domains-httpapi-GetDomainSendingQueuesResp":{"id":"components/schemas/github.com-mailgun-domains-httpapi-GetDomainSendingQueuesResp","kind":"json-schema","title":"github.com-mailgun-domains-httpapi-GetDomainSendingQueuesResp","data":{"type":"object","properties":{"regular":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-httpapi-ExceededQueueQuotaJSON"}],"description":"Message queue response"},"scheduled":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-domains-httpapi-ExceededQueueQuotaJSON"}],"description":"Scheduled message queue response"}},"required":["regular","scheduled"]}},"components/schemas/github.com-mailgun-pendulum-dkim-DNSRecord":{"id":"components/schemas/github.com-mailgun-pendulum-dkim-DNSRecord","kind":"json-schema","title":"github.com-mailgun-pendulum-dkim-DNSRecord","data":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"identifier":{"type":"string"},"value":{"type":"string"},"comment":{"type":"string"}},"required":["name","type","identifier","value","comment"]}},"components/schemas/github.com-mailgun-pendulum-api-Domain":{"id":"components/schemas/github.com-mailgun-pendulum-api-Domain","kind":"json-schema","title":"github.com-mailgun-pendulum-api-Domain","data":{"type":"object","properties":{"id":{"type":"string"},"account_id":{"type":"string"},"sid":{"type":"string"},"name":{"type":"string"},"state":{"type":"string"},"active_selector":{"type":"string"},"rotation_enabled":{"type":"string"},"rotation_interval":{"type":"string"},"records":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-pendulum-dkim-DNSRecord"}}},"required":["id","account_id","sid","name","state","rotation_enabled","rotation_interval"]}},"components/schemas/github.com-mailgun-pendulum-api-DomainResponse":{"id":"components/schemas/github.com-mailgun-pendulum-api-DomainResponse","kind":"json-schema","title":"github.com-mailgun-pendulum-api-DomainResponse","data":{"type":"object","properties":{"domain":{"$ref":"#/components/schemas/github.com-mailgun-pendulum-api-Domain"}},"required":["domain"]}},"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError":{"id":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError","kind":"json-schema","title":"github.com-mailgun-scaffold-httpapi-GenericAPIError","data":{"type":"object","properties":{"Reason":{"type":"string"}},"required":["Reason"]}},"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError":{"id":"components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError","kind":"json-schema","title":"github.com-mailgun-scaffold-httpapi-NotFoundError","data":{"type":"object","properties":{"Description":{"type":"string"}},"required":["Description"]}},"components/schemas/PUT-v1-dkim_management-domains-name-rotation-multipart-form-data-RequestBody":{"id":"components/schemas/PUT-v1-dkim_management-domains-name-rotation-multipart-form-data-RequestBody","kind":"json-schema","title":"PUT-v1-dkim_management-domains-name-rotation-multipart-form-data-RequestBody","data":{"type":"object","properties":{"rotation_enabled":{"type":"boolean","description":"If true, enables DKIM Auto-Rotation. If false, disables it"},"rotation_interval":{"type":"string","description":"The interval at which to rotate keys. Example, '5d' for five days"}},"required":["rotation_enabled"]}},"components/schemas/github.com-mailgun-tower-api-subaccounts-ListSubaccountDIPPsResponseItem":{"id":"components/schemas/github.com-mailgun-tower-api-subaccounts-ListSubaccountDIPPsResponseItem","kind":"json-schema","title":"github.com-mailgun-tower-api-subaccounts-ListSubaccountDIPPsResponseItem","data":{"type":"object","properties":{"pool_id":{"type":"string"},"subaccount_id":{"type":"string"}},"required":["pool_id","subaccount_id"]}},"components/schemas/github.com-mailgun-tower-api-subaccounts-ListSubaccountDIPPsResponse":{"id":"components/schemas/github.com-mailgun-tower-api-subaccounts-ListSubaccountDIPPsResponse","kind":"json-schema","title":"github.com-mailgun-tower-api-subaccounts-ListSubaccountDIPPsResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-tower-api-subaccounts-ListSubaccountDIPPsResponseItem"}},"total_count":{"type":"integer","format":"int32"}},"required":["items","total_count"]}},"components/schemas/github.com-mailgun-tower-api-StartSagaResponse":{"id":"components/schemas/github.com-mailgun-tower-api-StartSagaResponse","kind":"json-schema","title":"github.com-mailgun-tower-api-StartSagaResponse","data":{"type":"object","properties":{"message":{"type":"string"},"reference_id":{"type":"string"}},"required":["message","reference_id"]}},"components/schemas/github.com-mailgun-tower-api-domain-dipp_spillover-DIPPSpilloverDoc":{"id":"components/schemas/github.com-mailgun-tower-api-domain-dipp_spillover-DIPPSpilloverDoc","kind":"json-schema","title":"github.com-mailgun-tower-api-domain-dipp_spillover-DIPPSpilloverDoc","data":{"type":"object","properties":{"pool_id":{"type":"string","description":"the ID of the IP pool that spillover IPs are assigned to"}},"required":["pool_id"]}},"components/schemas/github.com-mailgun-tower-api-domain-dipp_spillover-DIPPSpilloverResponseDoc":{"id":"components/schemas/github.com-mailgun-tower-api-domain-dipp_spillover-DIPPSpilloverResponseDoc","kind":"json-schema","title":"github.com-mailgun-tower-api-domain-dipp_spillover-DIPPSpilloverResponseDoc","data":{"type":"object","properties":{"extra_dedicated_ips":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-tower-api-domain-dipp_spillover-DIPPSpilloverDoc"}],"description":"the DIPP spillover settings for the account"}},"required":["extra_dedicated_ips"]}},"components/schemas/github.com-mailgun-tower-api-domain-dipp_spillover-DIPPSpilloverRequest":{"id":"components/schemas/github.com-mailgun-tower-api-domain-dipp_spillover-DIPPSpilloverRequest","kind":"json-schema","title":"github.com-mailgun-tower-api-domain-dipp_spillover-DIPPSpilloverRequest","data":{"type":"object","properties":{"pool_id":{"type":["string","null"],"description":"the ID of the IP pool that spillover IPs are assigned to"}},"required":["pool_id"]}},"components/schemas/github.com-mailgun-tower-api-domain-dipp_spillover-DIPPSpilloverSettingsRequest":{"id":"components/schemas/github.com-mailgun-tower-api-domain-dipp_spillover-DIPPSpilloverSettingsRequest","kind":"json-schema","title":"github.com-mailgun-tower-api-domain-dipp_spillover-DIPPSpilloverSettingsRequest","data":{"type":"object","properties":{"extra_dedicated_ips":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-tower-api-domain-dipp_spillover-DIPPSpilloverRequest"}],"description":"the DIPP spillover settings for the account"}},"required":["extra_dedicated_ips"]}},"components/schemas/github.com-mailgun-tower-api-account-dipp_spillover-DIPPSpilloverDoc":{"id":"components/schemas/github.com-mailgun-tower-api-account-dipp_spillover-DIPPSpilloverDoc","kind":"json-schema","title":"github.com-mailgun-tower-api-account-dipp_spillover-DIPPSpilloverDoc","data":{"type":"object","properties":{"pool_id":{"type":"string","description":"the ID of the IP pool that spillover IPs are assigned to"}},"required":["pool_id"]}},"components/schemas/github.com-mailgun-tower-api-account-dipp_spillover-DIPPSpilloverResponseDoc":{"id":"components/schemas/github.com-mailgun-tower-api-account-dipp_spillover-DIPPSpilloverResponseDoc","kind":"json-schema","title":"github.com-mailgun-tower-api-account-dipp_spillover-DIPPSpilloverResponseDoc","data":{"type":"object","properties":{"extra_dedicated_ips":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-tower-api-account-dipp_spillover-DIPPSpilloverDoc"}],"description":"the DIPP spillover settings for the account.  This value will apply to all domains under the account"}},"required":["extra_dedicated_ips"]}},"components/schemas/github.com-mailgun-tower-api-account-dipp_spillover-DIPPSpilloverRequest":{"id":"components/schemas/github.com-mailgun-tower-api-account-dipp_spillover-DIPPSpilloverRequest","kind":"json-schema","title":"github.com-mailgun-tower-api-account-dipp_spillover-DIPPSpilloverRequest","data":{"type":"object","properties":{"pool_id":{"type":["string","null"],"description":"the ID of the IP pool that spillover IPs are assigned to"}},"required":["pool_id"]}},"components/schemas/github.com-mailgun-tower-api-account-dipp_spillover-DIPPSpilloverSettingsRequest":{"id":"components/schemas/github.com-mailgun-tower-api-account-dipp_spillover-DIPPSpilloverSettingsRequest","kind":"json-schema","title":"github.com-mailgun-tower-api-account-dipp_spillover-DIPPSpilloverSettingsRequest","data":{"type":"object","properties":{"extra_dedicated_ips":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-tower-api-account-dipp_spillover-DIPPSpilloverRequest"}],"description":"the DIPP spillover settings for the account.  This value will apply to all domains under the account"}},"required":["extra_dedicated_ips"]}},"components/schemas/github.com-mailgun-tower-api-account-list_ips-detailsDocResponse":{"id":"components/schemas/github.com-mailgun-tower-api-account-list_ips-detailsDocResponse","kind":"json-schema","title":"github.com-mailgun-tower-api-account-list_ips-detailsDocResponse","data":{"type":"object","properties":{"ip":{"type":"string","description":"the IP address"},"is_on_warmup":{"type":"boolean","description":"whether the IP is on warmup"},"dedicated":{"type":"boolean","description":"whether the IP is dedicated"},"enabled":{"type":"boolean","description":"whether the IP is enabled"}},"required":["ip","is_on_warmup","dedicated","enabled"]}},"components/schemas/github.com-mailgun-tower-api-account-list_ips-docResponse":{"id":"components/schemas/github.com-mailgun-tower-api-account-list_ips-docResponse","kind":"json-schema","title":"github.com-mailgun-tower-api-account-list_ips-docResponse","data":{"type":"object","properties":{"assignable_to_pools":{"type":"array","items":{"type":"string"},"description":"list of IPs that can be assigned to dedicated IP pools."},"details":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-tower-api-account-list_ips-detailsDocResponse"},"description":"list of detailed information for each IP"},"items":{"type":"array","items":{"type":"string"},"description":"list of IPs"},"total_count":{"type":"integer","format":"int32","description":"total number of IPs for the given query"}},"required":["details","items","total_count"]}},"components/schemas/github.com-mailgun-tower-api-account-getDocResponse":{"id":"components/schemas/github.com-mailgun-tower-api-account-getDocResponse","kind":"json-schema","title":"github.com-mailgun-tower-api-account-getDocResponse","data":{"type":"object","properties":{"dedicated":{"type":"boolean","description":"whether the IP is dedicated or shared"},"ip":{"type":"string","description":"IP address"},"rdns":{"type":"string","description":"reverse DNS of the IP address"}},"required":["dedicated","ip","rdns"]}},"components/schemas/github.com-mailgun-tower-api-account-Item":{"id":"components/schemas/github.com-mailgun-tower-api-account-Item","kind":"json-schema","title":"github.com-mailgun-tower-api-account-Item","data":{"type":"object","properties":{"ips":{"type":"array","items":{"type":"string"},"description":"list of IPs linked to the domain"},"domain":{"type":"string","description":"domain name"},"linked_at":{"type":"string","description":"a UTC timestamp in RFC3339 format representing when the IP was linked to the domain"}},"required":["ips","domain"]}},"components/schemas/github.com-mailgun-tower-api-account-domainsResponse":{"id":"components/schemas/github.com-mailgun-tower-api-account-domainsResponse","kind":"json-schema","title":"github.com-mailgun-tower-api-account-domainsResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-tower-api-account-Item"},"description":"list of domains with the IP assigned, along with the IPs assigned to each domain"},"total_count":{"type":"integer","format":"int32","description":"total number of domains with the IP assigned for the given query"}},"required":["items","total_count"]}},"components/schemas/POST-v3-ips-addr-ip_band-multipart-form-data-RequestBody":{"id":"components/schemas/POST-v3-ips-addr-ip_band-multipart-form-data-RequestBody","kind":"json-schema","title":"POST-v3-ips-addr-ip_band-multipart-form-data-RequestBody","data":{"type":"object","properties":{"ip_band":{"type":"string","description":"Dedicated IP band to place the IP address into"}},"required":["ip_band"]}},"components/schemas/github.com-mailgun-tower-api-account-list_ips-AccountIPDoc":{"id":"components/schemas/github.com-mailgun-tower-api-account-list_ips-AccountIPDoc","kind":"json-schema","title":"github.com-mailgun-tower-api-account-list_ips-AccountIPDoc","data":{"type":"object","properties":{"address":{"type":"string","description":"the IP address"},"parent_account_id":{"type":"string","description":"the id of the parent account"},"account_id":{"type":"string","description":"the id of the account"},"pool_ids":{"type":"array","items":{"type":"string"},"description":"list of pool ids"},"dedicated":{"type":"boolean","description":"whether the IP is dedicated"},"created_at":{"type":"string","format":"date-time","description":"the time the IP was created"},"pool_last_modified_at":{"type":"string","format":"date-time","description":"the last time the pool was modified"},"domains_last_modified_at":{"type":"string","format":"date-time","description":"the last time the domains were modified"}},"required":["address","parent_account_id","account_id","pool_ids","dedicated","pool_last_modified_at","domains_last_modified_at"]}},"components/schemas/github.com-mailgun-tower-api-account-list_ips-DetailedIPsResponseDoc":{"id":"components/schemas/github.com-mailgun-tower-api-account-list_ips-DetailedIPsResponseDoc","kind":"json-schema","title":"github.com-mailgun-tower-api-account-list_ips-DetailedIPsResponseDoc","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-tower-api-account-list_ips-AccountIPDoc"},"description":"list of IPs belonging to the account and subaccounts"},"total_count":{"type":"integer","format":"int64","description":"total number of account IPs"}},"required":["items","total_count"]}},"components/schemas/github.com-mailgun-scaffold-httpapi-Response":{"id":"components/schemas/github.com-mailgun-scaffold-httpapi-Response","kind":"json-schema","title":"github.com-mailgun-scaffold-httpapi-Response","data":{"type":"object","additionalProperties":{"type":"object"}}},"components/schemas/POST-v3-dynamic_pools-all-multipart-form-data-RequestBody":{"id":"components/schemas/POST-v3-dynamic_pools-all-multipart-form-data-RequestBody","kind":"json-schema","title":"POST-v3-dynamic_pools-all-multipart-form-data-RequestBody","data":{"type":"object","properties":{"good_reputation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IP(s) to include in the good_reputation pool"},"children":[]}]}]}]},"poor_reputation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IP(s) to include in the poor_reputation pool"},"children":[]}]}]}]},"new_senders":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IP(s) to include in the new_senders pool"},"children":[]}]}]}]}},"required":["good_reputation","poor_reputation","new_senders"]}},"components/schemas/PATCH-v3-dynamic_pools-pool_name-multipart-form-data-RequestBody":{"id":"components/schemas/PATCH-v3-dynamic_pools-pool_name-multipart-form-data-RequestBody","kind":"json-schema","title":"PATCH-v3-dynamic_pools-pool_name-multipart-form-data-RequestBody","data":{"type":"object","properties":{"add_ip":{"type":"string","description":"IP(s) to add to the pool"},"remove_ip":{"type":"string","description":"IP(s) to remove from the pool"}},"required":["add_ip","remove_ip"]}},"components/schemas/github.com-mailgun-tower-api-ip_pools-list-IPAssignment":{"id":"components/schemas/github.com-mailgun-tower-api-ip_pools-list-IPAssignment","kind":"json-schema","title":"github.com-mailgun-tower-api-ip_pools-list-IPAssignment","data":{"type":"object","properties":{"linked_at":{"type":"string","description":"a UTC timestamp in RFC3339 format representing when the IP was linked to the pool"}},"required":["linked_at"]}},"components/schemas/github.com-mailgun-tower-api-ip_pools-list-PoolMetadata":{"id":"components/schemas/github.com-mailgun-tower-api-ip_pools-list-PoolMetadata","kind":"json-schema","title":"github.com-mailgun-tower-api-ip_pools-list-PoolMetadata","data":{"type":"object","properties":{"assignments":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/github.com-mailgun-tower-api-ip_pools-list-IPAssignment"},"description":"assignment metadata keyed by IP address"}},"required":["assignments"]}},"components/schemas/github.com-mailgun-tower-api-ip_pools-list-DIPPDetailsResponse":{"id":"components/schemas/github.com-mailgun-tower-api-ip_pools-list-DIPPDetailsResponse","kind":"json-schema","title":"github.com-mailgun-tower-api-ip_pools-list-DIPPDetailsResponse","data":{"type":"object","properties":{"description":{"type":"string","description":"long description of the dedicated IP pool"},"ips":{"type":"array","items":{"type":"string"},"description":"list of IPs in the dedicated IP pool"},"metadata":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-tower-api-ip_pools-list-PoolMetadata"}],"description":"metadata for the dedicated IP pool"},"is_inherited":{"type":"boolean","description":"indicates if the IP pool is inherited"},"is_linked":{"type":"boolean","description":"indicates if the IP pool is linked to any domains"},"name":{"type":"string","description":"short name of the dedicated IP pool"},"pool_id":{"type":"string","description":"the id of the dedicated IP pool"}},"required":["description","ips","metadata","is_inherited","is_linked","name","pool_id"]}},"components/schemas/github.com-mailgun-tower-api-ip_pools-list-successResponse":{"id":"components/schemas/github.com-mailgun-tower-api-ip_pools-list-successResponse","kind":"json-schema","title":"github.com-mailgun-tower-api-ip_pools-list-successResponse","data":{"type":"object","properties":{"ip_pools":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-tower-api-ip_pools-list-DIPPDetailsResponse"},"description":"list of dedicated IP pools of the account"},"message":{"type":"string","description":"success if the request was successful, otherwise contains a description of the error"}},"required":["ip_pools","message"]}},"components/schemas/POST-v3-ip_pools-multipart-form-data-RequestBody":{"id":"components/schemas/POST-v3-ip_pools-multipart-form-data-RequestBody","kind":"json-schema","title":"POST-v3-ip_pools-multipart-form-data-RequestBody","data":{"type":"object","properties":{"description":{"type":"string","description":"Description of the DIPP"},"ip":{"type":"string","description":"IP address to add to the DIPP (may be specified multiple times)"},"name":{"type":"string","description":"Short name of the DIPP"}},"required":["description","name"]}},"components/schemas/PATCH-v3-ip_pools-pool_id-multipart-form-data-RequestBody":{"id":"components/schemas/PATCH-v3-ip_pools-pool_id-multipart-form-data-RequestBody","kind":"json-schema","title":"PATCH-v3-ip_pools-pool_id-multipart-form-data-RequestBody","data":{"type":"object","properties":{"add_ip":{"type":"string","description":"The IP to add to the DIPP (may be specified multiple times)"},"description":{"type":"string","description":"The new description for the DIPP"},"link_domain":{"type":"string","description":"The ID of the domain link to the DIPP (may be specified multiple times)"},"name":{"type":"string","description":"The new short for the DIPP"},"remove_ip":{"type":"string","description":"The IP to remove from the DIPP (may be specified multiple times)"},"unlink_domain":{"type":"string","description":"The ID of the domain to unlink from the DIPP (may be specified multiple times)"}}}},"components/schemas/github.com-mailgun-tower-api-ip_pools-add_ip-addMultipleIPsRequestBody":{"id":"components/schemas/github.com-mailgun-tower-api-ip_pools-add_ip-addMultipleIPsRequestBody","kind":"json-schema","title":"github.com-mailgun-tower-api-ip_pools-add_ip-addMultipleIPsRequestBody","data":{"type":"object","properties":{"ips":{"type":"array","items":{"type":"string"},"description":"IPs to add to the DIPP"}},"required":["ips"]}},"components/schemas/PUT-v3-ip_pools-pool_id-delegate-multipart-form-data-RequestBody":{"id":"components/schemas/PUT-v3-ip_pools-pool_id-delegate-multipart-form-data-RequestBody","kind":"json-schema","title":"PUT-v3-ip_pools-pool_id-delegate-multipart-form-data-RequestBody","data":{"type":"object","properties":{"subaccount_id":{"type":"string","description":"The ID of the subaccount to delegate the pool to"}},"required":["subaccount_id"]}},"components/schemas/DELETE-v3-ip_pools-pool_id-delegate-multipart-form-data-RequestBody":{"id":"components/schemas/DELETE-v3-ip_pools-pool_id-delegate-multipart-form-data-RequestBody","kind":"json-schema","title":"DELETE-v3-ip_pools-pool_id-delegate-multipart-form-data-RequestBody","data":{"type":"object","properties":{"subaccount_id":{"type":"string","description":"The ID of the subaccount to revoke the pool from"}},"required":["subaccount_id"]}},"components/schemas/github.com-mailgun-bandersnatch-model-Domain":{"id":"components/schemas/github.com-mailgun-bandersnatch-model-Domain","kind":"json-schema","title":"github.com-mailgun-bandersnatch-model-Domain","data":{"type":"object","properties":{"id":{"type":"string"},"account_id":{"type":"string"},"account_name":{"type":"string"},"name":{"type":"string"},"registered_at":{"type":"string","format":"date-time"},"pool":{"type":"string"},"override":{"type":"boolean"},"bounce_rate":{"type":["number","null"],"format":"float"},"complaint_rate":{"type":["number","null"],"format":"float"},"processed_count":{"type":["integer","null"],"format":"int64"}},"required":["id","account_id","account_name","name","registered_at","pool","override"]}},"components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingURLs":{"id":"components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingURLs","kind":"json-schema","title":"github.com-mailgun-scaffold-httpapi-paging-PagingURLs","data":{"type":"object","properties":{"Next":{"type":"string"},"Previous":{"type":"string"},"First":{"type":"string"},"Last":{"type":"string"}},"required":["Next","Previous","First","Last"]}},"components/schemas/github.com-mailgun-bandersnatch-api-DomainListResponse":{"id":"components/schemas/github.com-mailgun-bandersnatch-api-DomainListResponse","kind":"json-schema","title":"github.com-mailgun-bandersnatch-api-DomainListResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-bandersnatch-model-Domain"}},"total_items":{"type":"integer","format":"int32"},"paging":{"$ref":"#/components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingURLs"}},"required":["items","total_items","paging"]}},"components/schemas/github.com-mailgun-bandersnatch-model-HistoryRecord":{"id":"components/schemas/github.com-mailgun-bandersnatch-model-HistoryRecord","kind":"json-schema","title":"github.com-mailgun-bandersnatch-model-HistoryRecord","data":{"type":"object","properties":{"id":{"type":"string"},"owning_account_id":{"type":"string"},"account_id":{"type":"string"},"account_name":{"type":"string"},"domain_id":{"type":"string"},"domain_name":{"type":"string"},"new_band":{"type":"string"},"prev_band":{"type":"string"},"reason":{"type":"string"},"bounce_rate":{"type":["number","null"],"format":"float"},"complaint_rate":{"type":["number","null"],"format":"float"},"processed_count":{"type":["integer","null"],"format":"int64"},"initiated_by":{"type":"string"},"timestamp":{"type":"string","format":"date-time"}},"required":["id","owning_account_id","account_id","account_name","domain_id","domain_name","new_band","prev_band","reason","bounce_rate","timestamp"]}},"components/schemas/github.com-mailgun-scaffold-httpapi-InvalidParameterError":{"id":"components/schemas/github.com-mailgun-scaffold-httpapi-InvalidParameterError","kind":"json-schema","title":"github.com-mailgun-scaffold-httpapi-InvalidParameterError","data":{"type":"object","properties":{"Field":{"type":"string"},"Value":{"type":"string"}},"required":["Field","Value"]}},"components/schemas/PUT-v1-dynamic_pools-domains-name-override-multipart-form-data-RequestBody":{"id":"components/schemas/PUT-v1-dynamic_pools-domains-name-override-multipart-form-data-RequestBody","kind":"json-schema","title":"PUT-v1-dynamic_pools-domains-name-override-multipart-form-data-RequestBody","data":{"type":"object","properties":{"pool":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the Dynamic IP pool to override the domain with. Must be a valid pool name (ex: dynamic_good, dynamic_new, etc.)"},"children":[]}]}]}]}},"required":["pool"]}},"components/schemas/github.com-mailgun-bandersnatch-api-ListHistoryResponse":{"id":"components/schemas/github.com-mailgun-bandersnatch-api-ListHistoryResponse","kind":"json-schema","title":"github.com-mailgun-bandersnatch-api-ListHistoryResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-bandersnatch-model-HistoryRecord"}},"total_items":{"type":"integer","format":"int32"},"paging":{"$ref":"#/components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingURLs"}},"required":["items","total_items","paging"]}},"components/schemas/github.com-mailgun-terminator-httpapi-StatusResponse":{"id":"components/schemas/github.com-mailgun-terminator-httpapi-StatusResponse","kind":"json-schema","title":"github.com-mailgun-terminator-httpapi-StatusResponse","data":{"type":"object","properties":{"status":{"type":"object","description":"Status of certificate. Either 'expired' 'processing' 'active' or 'error'"},"error":{"type":["string","null"],"description":"An error message if an error occurred. Null if there is no error."},"certificate":{"type":"string","description":"The x509 certificate in PEM format. Present only if the certificate status is 'active' 'error' or 'expired'"}},"required":["status","error"]}},"components/schemas/github.com-mailgun-terminator-httpapi-GenerateResponse":{"id":"components/schemas/github.com-mailgun-terminator-httpapi-GenerateResponse","kind":"json-schema","title":"github.com-mailgun-terminator-httpapi-GenerateResponse","data":{"type":"object","properties":{"message":{"type":"string","description":"A message indicating the status of the request."},"location":{"type":"string","description":"The URL path to check the status of the certificate."}},"required":["message","location"]}},"components/schemas/github.com-mailgun-scaffold-httpapi-ConflictError":{"id":"components/schemas/github.com-mailgun-scaffold-httpapi-ConflictError","kind":"json-schema","title":"github.com-mailgun-scaffold-httpapi-ConflictError","data":{"type":"object","properties":{"Description":{"type":"string"}},"required":["Description"]}},"components/schemas/EventResponse":{"id":"components/schemas/EventResponse","kind":"json-schema","title":"EventResponse","data":{"type":"object","title":"EventResponse","properties":{"method":{"type":"string"},"id":{"type":"string","description":"GUID identifying the individual event"},"event":{"$ref":"#/components/schemas/EventType"},"timestamp":{"type":"number","description":"Unix epoch, in nanoseconds, when the event was first created"},"log-level":{"type":"string","description":"Logging categorization between","enum":["info","warn","error"],"x-enumDescriptions":{"info":"Info event","warn":"Warn event","error":"Error event"}},"flags":{"type":"object","properties":{"is-authenticated":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if it’s an outgoing message. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if it’s incoming."},"children":[]}]}]}]},"is-routed":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the message was sent as a result of a Route match"},"children":[]}]}]}]},"is-amp":{"type":"boolean","description":"Tells if the message has AMP component in"},"is-encrypted":{"type":"boolean","description":"Tells if the message has been encrypted before stored"},"is-test-mode":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the message has been marked as delivered but the actual send stop before sending to the ESP"},"children":[]}]}]}]}}},"reject":{"type":"object","properties":{"reason":{"type":"string"},"description":{"type":"string"}}},"message":{"$ref":"#/components/schemas/MessageObject"},"tags":{"type":"array","items":{"type":"string"}},"user-variables":{"type":"object","description":"Variables included in the email"},"storage":{"type":"object","properties":{"key":{"type":"string","description":"Key ID for the stored MIME"},"url":{"type":"string","description":"URL for the stored MIME for retrieval, if required"},"region":{"type":"string","description":"The datacenter region the message is stored in"}}},"geolocation":{"type":"object","description":"Location data based on the client IP","properties":{"country":{"type":"string"},"region":{"type":"string"},"city":{"type":"string"}}},"client-info":{"type":"object","properties":{"client-type":{"type":"string","description":"Categorize client between: mobile browser, library, email client, robot, feed reader or other"},"client-os":{"type":"string","description":"The client Operating System"},"device-type":{"type":"string","description":"Could be: desktop, mobile, table or unknown"},"client-name":{"type":"string","description":"The client product identifier"},"user-agent":{"type":"string"}}},"ip":{"type":"string"},"delivery-status":{"$ref":"#/components/schemas/DeliveryStatusObject"},"batch":{"type":"object","properties":{"id":{"type":"string"}}},"severity":{"$ref":"#/components/schemas/EventSeverityType"},"recipient-domain":{"type":"string","description":"ESP domain"},"recipient-provider":{"type":"string","description":"Name of the Inbox Provider for the given recipient, if known"},"template":{"type":"object","properties":{"name":{"type":"string","description":"Name of the template the message was rendered from, if given"},"version":{"type":"string","description":"The version of the template that was rendered"},"is-text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tell if the template is considered as plain text (in opposition to ‘html’)"},"children":[]}]}]}]}}},"envelope":{"$ref":"#/components/schemas/EnvelopeObject"}}}},"components/schemas/MessageObject":{"id":"components/schemas/MessageObject","kind":"json-schema","title":"MessageObject","data":{"type":"object","title":"MessageObject","properties":{"attachments":{"type":"array","items":{"type":"object","properties":{"filename":{"type":"string","description":"The name of the file attached to the message"},"content-type":{"type":"string","description":"The type of the content attached to the message"},"size":{"type":"integer","description":"The attachment size in bytes"}},"required":["filename","content-type","size"]}},"headers":{"type":"object","properties":{"message-id":{"type":"string"},"from":{"type":"string","description":"Message FROM header"},"to":{"type":"string","description":"Message TO header"},"subject":{"type":"string","description":"Message Subject"}},"required":["message-id","from"]},"size":{"type":"integer","description":"Total message size, in bytes"},"scheduled-for":{"type":"string","description":"Date/Time the message was scheduled for delivery on ingest"}},"required":["headers","attachments","size"]}},"components/schemas/DeliveryStatusObject":{"id":"components/schemas/DeliveryStatusObject","kind":"json-schema","title":"DeliveryStatusObject","data":{"type":"object","title":"DeliveryStatusObject","properties":{"code":{"type":"integer","description":"SMTP status code received as a result of the ESP session"},"attempt-no":{"type":"integer","description":"The current attempt number trying to deliver the message to the ESP"},"message":{"type":"string"},"description":{"type":"string"},"enhanced-code":{"type":"string","description":"A more specific SMTP error code from the ESP"},"mxhost":{"type":"string","description":"The mailing host connected to for the SMTP session"},"certificate-verified":{"type":"boolean"},"tls":{"type":"boolean","description":"True if the SMTP session was performed over a TLS connection with the ESP"},"utf8":{"type":"boolean","description":"True if the SMTP session was able to use UTF-8 encoding"},"first-delivery-attempt-seconds":{"type":"number","description":"Time elapsed between when the message is accepted by us and the first delivery attempt to the email service provider (ESP)"},"session-seconds":{"type":"number","description":"The time, in seconds, the SMTP session for this message took"},"retry-seconds":{"type":"integer","description":"If the message failed for a reason that can be retried, the number of seconds between retry attempts. This value changes as the number of retries grows!"}}}},"components/schemas/EnvelopeObject":{"id":"components/schemas/EnvelopeObject","kind":"json-schema","title":"EnvelopeObject","data":{"type":"object","title":"EnvelopeObject","properties":{"sender":{"type":"string","description":"The sender address"},"targets":{"type":"string","description":"The recipient address"},"transport":{"type":"string","description":"The protocol used to make the send. Either http or smtp"},"sending-ip":{"type":"string","description":"The Mailgun IP the email has been sent from"}}}},"components/schemas/EventType":{"id":"components/schemas/EventType","kind":"json-schema","title":"EventType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The event name. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/events/#introduction-to-events"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events"},"children":[]}]}]}]}],"enum":["accepted","delivered","failed","rejected","clicked","opened","unsubscribed","stored","complained","email_validation","list_member_uploaded","list_member_upload_error","list_uploaded"],"x-enumDescriptions":{"accepted":"Mailgun accepted the request to send/forward the email and the message has been placed in queue","delivered":"Mailgun sent the email, and it was accepted by the recipient email server","failed":"Mailgun could not deliver the email to the recipient email server","rejected":"Mailgun rejected the request to send/forward the email","clicked":"The email recipient clicked on a link in the email. Click tracking must be enabled in the Mailgun control panel, and the CNAME record must be pointing to mailgun.org","opened":"The email recipient opened the email and enabled image viewing. Open tracking must be enabled in the Mailgun control panel, and the CNAME record must be pointing to mailgun.org","unsubscribed":"The email recipient clicked on the unsubscribe link. Unsubscribe tracking must be enabled in the Mailgun control panel","stored":"Mail has stored an incoming message","complained":"The email recipient clicked on the spam complaint button within their email client. Feedback loops enable the notification to be received by Mailgun.","email_validation":"This event occurs onto email validation","list_member_uploaded":"This event occurs after successfully adding a member to a mailing list","list_member_upload_error":"This even occurs if an error occurs adding a member to a mailing list","list_uploaded":"This event occurs after successfully uploading a large list of members to a mailing list."}}},"components/schemas/EventSeverityType":{"id":"components/schemas/EventSeverityType","kind":"json-schema","title":"EventSeverityType","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by event severity, if exists. Currently for failed events only. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/tracking-messages/#tracking-failures"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking Failures"},"children":[]}]}]}]}],"type":"string","enum":["temporary","permanent"],"x-enumDescriptions":{"temporary":"Mailgun could not deliver the email to the recipient email server, but will retry","permanent":"Mailgun could not deliver the email to the recipient email server, and will drop the message without retrying sending."}}},"components/schemas/github.com-mailgun-scout-model-tags-TagItem":{"id":"components/schemas/github.com-mailgun-scout-model-tags-TagItem","kind":"json-schema","title":"github.com-mailgun-scout-model-tags-TagItem","data":{"type":"object","properties":{"tag":{"type":"string"},"description":{"type":"string"},"first-seen":{"type":"string","format":"date-time"},"last-seen":{"type":"string","format":"date-time"}},"required":["tag","description"]}},"components/schemas/github.com-mailgun-scout-api-TagListResponse":{"id":"components/schemas/github.com-mailgun-scout-api-TagListResponse","kind":"json-schema","title":"github.com-mailgun-scout-api-TagListResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-scout-model-tags-TagItem"}},"paging":{"$ref":"#/components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingResponse"}},"required":["items","paging"]}},"components/schemas/github.com-mailgun-scout-api-TagAggregateResponse":{"id":"components/schemas/github.com-mailgun-scout-api-TagAggregateResponse","kind":"json-schema","title":"github.com-mailgun-scout-api-TagAggregateResponse","data":{"type":"object","properties":{"tag":{"type":"string"},"provider":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}}},"country":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}}},"device":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}}}}}},"components/schemas/github.com-mailgun-scout-model-types-StatType":{"id":"components/schemas/github.com-mailgun-scout-model-types-StatType","kind":"json-schema","title":"github.com-mailgun-scout-model-types-StatType","data":{"type":"object","properties":{"type":{"type":"string"},"key":{"type":"string"}},"required":["type","key"]}},"components/schemas/github.com-mailgun-scout-model-stats-Accepted":{"id":"components/schemas/github.com-mailgun-scout-model-stats-Accepted","kind":"json-schema","title":"github.com-mailgun-scout-model-stats-Accepted","data":{"type":"object","properties":{"incoming":{"type":"integer","format":"int32"},"outgoing":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"}},"required":["incoming","outgoing","total"]}},"components/schemas/github.com-mailgun-scout-model-stats-Delivered":{"id":"components/schemas/github.com-mailgun-scout-model-stats-Delivered","kind":"json-schema","title":"github.com-mailgun-scout-model-stats-Delivered","data":{"type":"object","properties":{"smtp":{"type":"integer","format":"int32"},"http":{"type":"integer","format":"int32"},"optimized":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"}},"required":["smtp","http","optimized","total"]}},"components/schemas/github.com-mailgun-scout-model-stats-Failed":{"id":"components/schemas/github.com-mailgun-scout-model-stats-Failed","kind":"json-schema","title":"github.com-mailgun-scout-model-stats-Failed","data":{"type":"object","properties":{"temporary":{"type":"object","properties":{"espblock":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"}},"required":["espblock","total"]},"permanent":{"type":"object","properties":{"suppress-bounce":{"type":"integer","format":"int32"},"suppress-unsubscribe":{"type":"integer","format":"int32"},"suppress-complaint":{"type":"integer","format":"int32"},"bounce":{"type":"integer","format":"int32"},"delayed-bounce":{"type":"integer","format":"int32"},"webhook":{"type":"integer","format":"int32"},"optimized":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"}},"required":["suppress-bounce","suppress-unsubscribe","suppress-complaint","bounce","delayed-bounce","webhook","optimized","total"]}},"required":["temporary","permanent"]}},"components/schemas/github.com-mailgun-scout-model-stats-Stored":{"id":"components/schemas/github.com-mailgun-scout-model-stats-Stored","kind":"json-schema","title":"github.com-mailgun-scout-model-stats-Stored","data":{"type":"object","properties":{"total":{"type":"integer","format":"int32"}},"required":["total"]}},"components/schemas/github.com-mailgun-scout-model-stats-Opened":{"id":"components/schemas/github.com-mailgun-scout-model-stats-Opened","kind":"json-schema","title":"github.com-mailgun-scout-model-stats-Opened","data":{"type":"object","properties":{"total":{"type":"integer","format":"int32"},"unique":{"type":"integer","format":"int32"}},"required":["total"]}},"components/schemas/github.com-mailgun-scout-model-stats-Clicked":{"id":"components/schemas/github.com-mailgun-scout-model-stats-Clicked","kind":"json-schema","title":"github.com-mailgun-scout-model-stats-Clicked","data":{"type":"object","properties":{"total":{"type":"integer","format":"int32"},"unique":{"type":"integer","format":"int32"}},"required":["total"]}},"components/schemas/github.com-mailgun-scout-model-stats-Unsubscribed":{"id":"components/schemas/github.com-mailgun-scout-model-stats-Unsubscribed","kind":"json-schema","title":"github.com-mailgun-scout-model-stats-Unsubscribed","data":{"type":"object","properties":{"total":{"type":"integer","format":"int32"}},"required":["total"]}},"components/schemas/github.com-mailgun-scout-model-stats-Complained":{"id":"components/schemas/github.com-mailgun-scout-model-stats-Complained","kind":"json-schema","title":"github.com-mailgun-scout-model-stats-Complained","data":{"type":"object","properties":{"total":{"type":"integer","format":"int32"}},"required":["total"]}},"components/schemas/github.com-mailgun-scout-model-stats-Campaign":{"id":"components/schemas/github.com-mailgun-scout-model-stats-Campaign","kind":"json-schema","title":"github.com-mailgun-scout-model-stats-Campaign","data":{"type":"object","properties":{"total":{"type":"integer","format":"int32"}},"required":["total"]}},"components/schemas/github.com-mailgun-scout-model-stats-EmailValidation":{"id":"components/schemas/github.com-mailgun-scout-model-stats-EmailValidation","kind":"json-schema","title":"github.com-mailgun-scout-model-stats-EmailValidation","data":{"type":"object","properties":{"total":{"type":"integer","format":"int32"},"public":{"type":"integer","format":"int32"},"valid":{"type":"integer","format":"int32"},"single":{"type":"integer","format":"int32"},"bulk":{"type":"integer","format":"int32"},"list":{"type":"integer","format":"int32"},"mailgun":{"type":"integer","format":"int32"},"mailjet":{"type":"integer","format":"int32"}},"required":["total","public","valid","single","bulk","list","mailgun","mailjet"]}},"components/schemas/github.com-mailgun-scout-model-stats-SeedTest":{"id":"components/schemas/github.com-mailgun-scout-model-stats-SeedTest","kind":"json-schema","title":"github.com-mailgun-scout-model-stats-SeedTest","data":{"type":"object","properties":{"total":{"type":"integer","format":"int32"}},"required":["total"]}},"components/schemas/github.com-mailgun-scout-model-stats-BlocklistMonitoring":{"id":"components/schemas/github.com-mailgun-scout-model-stats-BlocklistMonitoring","kind":"json-schema","title":"github.com-mailgun-scout-model-stats-BlocklistMonitoring","data":{"type":"object","properties":{"total":{"type":"integer","format":"int32"}},"required":["total"]}},"components/schemas/github.com-mailgun-scout-model-stats-EmailPreview":{"id":"components/schemas/github.com-mailgun-scout-model-stats-EmailPreview","kind":"json-schema","title":"github.com-mailgun-scout-model-stats-EmailPreview","data":{"type":"object","properties":{"total":{"type":"integer","format":"int32"}},"required":["total"]}},"components/schemas/github.com-mailgun-scout-model-stats-EmailPreviewFailed":{"id":"components/schemas/github.com-mailgun-scout-model-stats-EmailPreviewFailed","kind":"json-schema","title":"github.com-mailgun-scout-model-stats-EmailPreviewFailed","data":{"type":"object","properties":{"total":{"type":"integer","format":"int32"}},"required":["total"]}},"components/schemas/github.com-mailgun-scout-model-stats-LinkValidation":{"id":"components/schemas/github.com-mailgun-scout-model-stats-LinkValidation","kind":"json-schema","title":"github.com-mailgun-scout-model-stats-LinkValidation","data":{"type":"object","properties":{"total":{"type":"integer","format":"int32"}},"required":["total"]}},"components/schemas/github.com-mailgun-scout-model-stats-LinkValidationFailed":{"id":"components/schemas/github.com-mailgun-scout-model-stats-LinkValidationFailed","kind":"json-schema","title":"github.com-mailgun-scout-model-stats-LinkValidationFailed","data":{"type":"object","properties":{"total":{"type":"integer","format":"int32"}},"required":["total"]}},"components/schemas/github.com-mailgun-scout-model-stats-StatsItem":{"id":"components/schemas/github.com-mailgun-scout-model-stats-StatsItem","kind":"json-schema","title":"github.com-mailgun-scout-model-stats-StatsItem","data":{"type":"object","properties":{"time":{"type":"string"},"accepted":{"$ref":"#/components/schemas/github.com-mailgun-scout-model-stats-Accepted"},"delivered":{"$ref":"#/components/schemas/github.com-mailgun-scout-model-stats-Delivered"},"failed":{"$ref":"#/components/schemas/github.com-mailgun-scout-model-stats-Failed"},"stored":{"$ref":"#/components/schemas/github.com-mailgun-scout-model-stats-Stored"},"opened":{"$ref":"#/components/schemas/github.com-mailgun-scout-model-stats-Opened"},"clicked":{"$ref":"#/components/schemas/github.com-mailgun-scout-model-stats-Clicked"},"unsubscribed":{"$ref":"#/components/schemas/github.com-mailgun-scout-model-stats-Unsubscribed"},"complained":{"$ref":"#/components/schemas/github.com-mailgun-scout-model-stats-Complained"},"campaign":{"$ref":"#/components/schemas/github.com-mailgun-scout-model-stats-Campaign"},"email_validation":{"$ref":"#/components/schemas/github.com-mailgun-scout-model-stats-EmailValidation"},"seed_test":{"$ref":"#/components/schemas/github.com-mailgun-scout-model-stats-SeedTest"},"ip_blocklist_monitoring":{"$ref":"#/components/schemas/github.com-mailgun-scout-model-stats-BlocklistMonitoring"},"domain_blocklist_monitoring":{"$ref":"#/components/schemas/github.com-mailgun-scout-model-stats-BlocklistMonitoring"},"email_preview":{"$ref":"#/components/schemas/github.com-mailgun-scout-model-stats-EmailPreview"},"email_preview_failed":{"$ref":"#/components/schemas/github.com-mailgun-scout-model-stats-EmailPreviewFailed"},"link_validation":{"$ref":"#/components/schemas/github.com-mailgun-scout-model-stats-LinkValidation"},"link_validation_failed":{"$ref":"#/components/schemas/github.com-mailgun-scout-model-stats-LinkValidationFailed"}},"required":["time"]}},"components/schemas/github.com-mailgun-scout-api-StatsResponse":{"id":"components/schemas/github.com-mailgun-scout-api-StatsResponse","kind":"json-schema","title":"github.com-mailgun-scout-api-StatsResponse","data":{"type":"object","properties":{"tag":{"type":"string"},"description":{"type":"string"},"start":{"type":"string"},"end":{"type":"string"},"type":{"$ref":"#/components/schemas/github.com-mailgun-scout-model-types-StatType"},"resolution":{"type":"string"},"stats":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-scout-model-stats-StatsItem"}}},"required":["description","start","end","resolution","stats"]}},"components/schemas/github.com-mailgun-scout-api-StatTypesResponse":{"id":"components/schemas/github.com-mailgun-scout-api-StatTypesResponse","kind":"json-schema","title":"github.com-mailgun-scout-api-StatTypesResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"}}},"required":["items"]}},"components/schemas/github.com-mailgun-scout-model-types-TagLimitItem":{"id":"components/schemas/github.com-mailgun-scout-model-types-TagLimitItem","kind":"json-schema","title":"github.com-mailgun-scout-model-types-TagLimitItem","data":{"type":"object","properties":{"id":{"type":"string"},"limit":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"}},"required":["limit","count"]}},"components/schemas/github.com-mailgun-scout-api-ProvidersAggregateResponse":{"id":"components/schemas/github.com-mailgun-scout-api-ProvidersAggregateResponse","kind":"json-schema","title":"github.com-mailgun-scout-api-ProvidersAggregateResponse","data":{"type":"object","properties":{"providers":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}}}}}},"components/schemas/github.com-mailgun-scout-api-DevicesAggregateResponse":{"id":"components/schemas/github.com-mailgun-scout-api-DevicesAggregateResponse","kind":"json-schema","title":"github.com-mailgun-scout-api-DevicesAggregateResponse","data":{"type":"object","properties":{"devices":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}}}}}},"components/schemas/github.com-mailgun-scout-api-CountriesAggregateResponse":{"id":"components/schemas/github.com-mailgun-scout-api-CountriesAggregateResponse","kind":"json-schema","title":"github.com-mailgun-scout-api-CountriesAggregateResponse","data":{"type":"object","properties":{"countries":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}}}}}},"components/schemas/github.com-mailgun-analytics-client-golang-Pagination":{"id":"components/schemas/github.com-mailgun-analytics-client-golang-Pagination","kind":"json-schema","title":"github.com-mailgun-analytics-client-golang-Pagination","data":{"type":"object","properties":{"sort":{"type":"string","description":"Colon-separated value indicating column name and sort direction e.g. 'domain:asc'."},"skip":{"type":"integer","format":"int64","description":"The number of items to skip over when satisfying the request. To get the first page of data set skip to zero.  Then increment the skip by the limit for subsequent calls."},"limit":{"type":"integer","format":"int64","description":"The maximum number of items returned in the response."},"total":{"type":"integer","format":"int64","description":"The total number of items in the query result set."}},"required":["sort","skip","limit","total"]}},"components/schemas/github.com-mailgun-analytics-client-golang-Dimension":{"id":"components/schemas/github.com-mailgun-analytics-client-golang-Dimension","kind":"json-schema","title":"github.com-mailgun-analytics-client-golang-Dimension","data":{"type":"object","properties":{"dimension":{"type":"string","description":"The dimension"},"value":{"type":"string","description":"The dimension value"},"display_value":{"type":"string","description":"The dimension value in displayable form"}},"required":["dimension","value","display_value"]}},"components/schemas/github.com-mailgun-analytics-internal-api-RegularMetrics":{"id":"components/schemas/github.com-mailgun-analytics-internal-api-RegularMetrics","kind":"json-schema","title":"github.com-mailgun-analytics-internal-api-RegularMetrics","data":{"type":"object","properties":{"accepted_incoming_count":{"type":["integer","null"],"format":"int64"},"accepted_outgoing_count":{"type":["integer","null"],"format":"int64"},"accepted_count":{"type":["integer","null"],"format":"int64"},"delivered_smtp_count":{"type":["integer","null"],"format":"int64"},"delivered_http_count":{"type":["integer","null"],"format":"int64"},"delivered_optimized_count":{"type":["integer","null"],"format":"int64"},"delivered_count":{"type":["integer","null"],"format":"int64"},"stored_count":{"type":["integer","null"],"format":"int64"},"processed_count":{"type":["integer","null"],"format":"int64"},"sent_count":{"type":["integer","null"],"format":"int64"},"opened_count":{"type":["integer","null"],"format":"int64"},"clicked_count":{"type":["integer","null"],"format":"int64"},"unique_opened_count":{"type":["integer","null"],"format":"int64"},"unique_clicked_count":{"type":["integer","null"],"format":"int64"},"unsubscribed_count":{"type":["integer","null"],"format":"int64"},"complained_count":{"type":["integer","null"],"format":"int64"},"failed_count":{"type":["integer","null"],"format":"int64"},"temporary_failed_count":{"type":["integer","null"],"format":"int64"},"permanent_failed_count":{"type":["integer","null"],"format":"int64"},"temporary_failed_esp_block_count":{"type":["integer","null"],"format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use instead of esp_block_count."},"children":[]}]}]}]},"permanent_failed_esp_block_count":{"type":["integer","null"],"format":"int64"},"rate_limit_count":{"type":["integer","null"],"format":"int64"},"webhook_count":{"type":["integer","null"],"format":"int64"},"permanent_failed_optimized_count":{"type":["integer","null"],"format":"int64"},"permanent_failed_old_count":{"type":["integer","null"],"format":"int64"},"bounced_count":{"type":["integer","null"],"format":"int64"},"hard_bounces_count":{"type":["integer","null"],"format":"int64"},"soft_bounces_count":{"type":["integer","null"],"format":"int64"},"delayed_bounce_count":{"type":["integer","null"],"format":"int64"},"suppressed_bounces_count":{"type":["integer","null"],"format":"int64"},"suppressed_unsubscribed_count":{"type":["integer","null"],"format":"int64"},"suppressed_complaints_count":{"type":["integer","null"],"format":"int64"},"delivered_first_attempt_count":{"type":["integer","null"],"format":"int64"},"delayed_first_attempt_count":{"type":["integer","null"],"format":"int64"},"delivered_subsequent_count":{"type":["integer","null"],"format":"int64"},"delivered_two_plus_attempts_count":{"type":["integer","null"],"format":"int64"},"delivered_rate":{"type":"string"},"opened_rate":{"type":"string"},"clicked_rate":{"type":"string"},"unique_opened_rate":{"type":"string"},"unique_clicked_rate":{"type":"string"},"unsubscribed_rate":{"type":"string"},"complained_rate":{"type":"string"},"bounce_rate":{"type":"string"},"fail_rate":{"type":"string"},"permanent_fail_rate":{"type":"string"},"temporary_fail_rate":{"type":"string"},"delayed_rate":{"type":"string"}}}},"components/schemas/github.com-mailgun-analytics-internal-api-RegularItem":{"id":"components/schemas/github.com-mailgun-analytics-internal-api-RegularItem","kind":"json-schema","title":"github.com-mailgun-analytics-internal-api-RegularItem","data":{"type":"object","properties":{"dimensions":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-analytics-client-golang-Dimension"}},"metrics":{"$ref":"#/components/schemas/github.com-mailgun-analytics-internal-api-RegularMetrics"}}}},"components/schemas/github.com-mailgun-analytics-internal-api-RegularAggregates":{"id":"components/schemas/github.com-mailgun-analytics-internal-api-RegularAggregates","kind":"json-schema","title":"github.com-mailgun-analytics-internal-api-RegularAggregates","data":{"type":"object","properties":{"metrics":{"$ref":"#/components/schemas/github.com-mailgun-analytics-internal-api-RegularMetrics"}},"required":["metrics"]}},"components/schemas/github.com-mailgun-analytics-internal-api-RegularMetricsResponse":{"id":"components/schemas/github.com-mailgun-analytics-internal-api-RegularMetricsResponse","kind":"json-schema","title":"github.com-mailgun-analytics-internal-api-RegularMetricsResponse","data":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"},"resolution":{"type":"string"},"duration":{"type":"string"},"dimensions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/github.com-mailgun-analytics-client-golang-Pagination"},"items":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-analytics-internal-api-RegularItem"}},"aggregates":{"$ref":"#/components/schemas/github.com-mailgun-analytics-internal-api-RegularAggregates"}},"required":["items"]}},"components/schemas/github.com-mailgun-analytics-client-golang-DimensionName":{"id":"components/schemas/github.com-mailgun-analytics-client-golang-DimensionName","kind":"json-schema","title":"github.com-mailgun-analytics-client-golang-DimensionName","data":{"type":"string","enum":["bot","country","ip_pool","recipient_domain","recipient_provider","ip","domain","tag","device","subaccount","time"],"description":"Dimension","x-enumDescriptions":{"bot":"The automated system that engaged with the email, e.g. apple, gmail","country":"Country from which the email was sent, e.g. US, FR, MX","ip_pool":"IP pool used to send the email","recipient_domain":"Recipient domain, e.g. gmail.com","recipient_provider":"Email service provider of the recipient, e.g. Gmail, Outlook US, Apple","ip":"IP address used to send the email","domain":"Domain used to send the email, e.g. example.com","tag":"Custom tag attached to the message","device":"Type of device used to send the email, e.g. mobile, desktop","subaccount":"Subaccount identifier","time":"The time that your events occurred"}}},"components/schemas/github.com-mailgun-analytics-client-golang-Metric":{"id":"components/schemas/github.com-mailgun-analytics-client-golang-Metric","kind":"json-schema","title":"github.com-mailgun-analytics-client-golang-Metric","data":{"type":"string","enum":["accepted_incoming_count","accepted_outgoing_count","accepted_count","delivered_smtp_count","delivered_http_count","delivered_optimized_count","delivered_count","processed_count","sent_count","opened_count","clicked_count","unique_opened_count","unique_clicked_count","unsubscribed_count","complained_count","failed_count","temporary_failed_count","permanent_failed_count","temporary_failed_esp_block_count","permanent_failed_esp_block_count","webhook_count","rate_limit_count","permanent_failed_optimized_count","permanent_failed_old_count","bounced_count","hard_bounces_count","soft_bounces_count","delayed_bounce_count","suppressed_bounces_count","suppressed_unsubscribed_count","suppressed_complaints_count","delivered_first_attempt_count","delayed_first_attempt_count","delivered_two_plus_attempts_count","delivered_rate","opened_rate","clicked_rate","unique_opened_rate","unique_opened_rate","unsubscribed_rate","complained_rate","bounce_rate","permanent_fail_rate","temporary_fail_rate","delayed_rate","delayed_first_attempt_rate"],"description":"Metric","x-enumDescriptions":{"accepted_incoming_count":"Mailgun accepted the API request to forward, and the message has been put in your queue. These accepted events only cover routes, forwards, and mailing lists. Mailing lists will record a single accepted incoming event, with emails sent to recipients recording their own accepted outgoing events.","accepted_outgoing_count":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mailgun accepted the API request to send, and the message was put in your queue. Batch sends will result in one additional accepted outgoing event to record the initial batch request. Accepted events are not associated to IP addresses. The “processed” metric can be used in place of accepted to view data by IP."},"children":[]}]}]}],"accepted_count":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sum of incoming and outgoing accepted events. This includes all accepted emails to be sent as well as routes, forwards, mailing lists, and batch events. To only view accepted events on emails sent to recipients, use the Accepted Outgoing metric. Accepted events are not associated to IP addresses. The “processed” metric can be used in place of accepted to view similar data by IP."},"children":[]}]}]}],"delivered_smtp_count":"The count of delivered events for emails sent to recipient addresses.","delivered_http_count":"The count of delivered events for routes and forwards.","delivered_optimized_count":"Emails delivered with Send Time Optimization.","delivered_count":"Mailgun sent the email and it was accepted by the recipient email server.","processed_count":"Messages processed after being accepted. Processed messages are billed to your account at the end of the month.","sent_count":"A count of all sent messages. This includes delivered and failed messages, but does not include suppressed messages.","opened_count":"The email recipient opened the email and enabled image viewing. Tracking must be turned on.","clicked_count":"The email recipient clicked on a link in the email. Click tracking must be turned on and the CNAME record must be pointing to mailgun.org.","unique_opened_count":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique count of open events. Opens are deduplicated on a rolling seven days. If you’re viewing two weeks of data, it’s possible to see two unique open events for a single delivered event. Keep in mind date ranges when viewing unique opens, if your date filter doesn’t include the delivery event, you may see more unique opens than delivered events."},"children":[]}]}]}],"unique_clicked_count":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique count of click events. Clicks are deduplicated on a rolling seven days. If you’re viewing two weeks of data, it’s possible to see two unique click events for a single delivered event. Keep in mind date ranges when viewing unique clicks, if your date filter doesn’t include the delivery event, you may see more unique clicks than delivered events."},"children":[]}]}]}],"unsubscribed_count":"The email recipient clicked on the unsubscribe link. Unsubscribe tracking must be turned on.","complained_count":"The email recipient clicked on the spam complaint button and the recipient's email server provides feedback loops to Mailgun for these complaints.","failed_count":"A sum of all permanent and temporary failures.","temporary_failed_count":"Mailgun could not deliver the email to the recipient email server, but will retry.","permanent_failed_count":"Mailgun could not deliver the email to the recipient email server, and will drop the message without retrying sending.","temporary_failed_esp_block_count":"Emails that were temporarily blocked by the ESP for policy errors and reputation rate limiting.","permanent_failed_esp_block_count":"Emails that were permanently blocked by the ESP for policy errors and reputation rate limiting.","webhook_count":"A count of failed webhook events.","rate_limit_count":"A count of emails that were rate limited by Mailgun.","permanent_failed_optimized_count":"Events that were sent with send time optimization, but received a permanent failure.","permanent_failed_old_count":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mailgun attempted to deliver the email for the maximum number of retry attempts, but received a temporary failure each time. Upon the last retry attempt, the message was classified as a ”Too Old” permanent failure."},"children":[]}]}]}],"bounced_count":"A sum of all soft and hard bounces. Permanent failures fall into three categories, soft bounces, hard bounces, and suppressions. This field is equal to permanent failures minus suppressions.","hard_bounces_count":"A hard bounce is a message that cannot be delivered to its intended recipient due to an invalid recipient address or non-existent mailbox. These addresses will be automatically added to your suppressions list when you receive a hard bounce to prevent subsequent hard bounces.","soft_bounces_count":"A soft bounce is a message that cannot be delivered to its intended recipient due to a temporary delivery issue, often stemming from a server outage, full mailbox, oversize files/messages, blocklistings, or reputation issues. Mailgun treats soft bounces as permanent failures, meaning we will not automatically attempt to redeliver the message. The recipient address will not be added to the suppression list, and the next time you attempt to send a message to this recipient we will attempt to deliver.","delayed_bounce_count":"Emails were initially marked as delivered, but later received a permanent failure from the mailbox provider.","suppressed_bounces_count":"The email was suppressed due to a previous bounce with the recipient address. No delivery attempt was made.","suppressed_unsubscribed_count":"The email was suppressed due to a previous unsubscribe from the recipient. No delivery attempt was made.","suppressed_complaints_count":"The email was suppressed due to a previous complaint from the recipient. No delivery attempt was made.","delivered_first_attempt_count":"Emails that were delivered on the first delivery attempt without being delayed or bounced.","delayed_first_attempt_count":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Emails that were temporarily rejected on the first delivery attempt. These emails will have been retried until delivery or until a “too old” permanent failure is generated."},"children":[]}]}]}],"delivered_two_plus_attempts_count":"Emails that were delivered after two or more delivery attempts. This indicates the emails received at least one temporary failure.","delivered_rate":"The rate at which sent emails are delivered to recipient addresses. This calculation does not include suppressed emails.","opened_rate":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rate at which delivered emails are opened. This calculation uses total opens, not unique opens. Use the unique open rate if percentages exceed 100%."},"children":[]}]}]}],"clicked_rate":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rate at which delivered emails are clicked. This calculation uses total clicks, not unique clicks. Use the unique click rate if percentages exceed 100%."},"children":[]}]}]}],"unique_opened_rate":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The percentage of delivered emails that resulted in a unique click event. This calculation will exceed 100% if your date filter excludes a large amount of delivery events."},"children":[]}]}]}],"unsubscribed_rate":"The unsubscribe rate accounts for the total number of unsubscribes divided by the total number of emails delivered and multiplied by 100, expressed as a percentage.","complained_rate":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complaint rate measures the percentages of delivered emails reported as spam by recipients. This rate should be kept below 0.1%. Please note that Gmail does not provide complaints, to see Gmail complaint data, sign up for Google Postmaster Tools."},"children":[]}]}]}],"bounce_rate":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bounce rate measures the percentage of emails that bounce back, or the number of emails that couldn’t be delivered to users over the total number of emails sent."},"children":[]}]}]}],"permanent_fail_rate":"The percentage of sent emails that resulted in a permanent failure. These emails could not be delivered and will not be retried.","temporary_fail_rate":"The percentage of sent emails that resulted in a temporary failure.","delayed_rate":"The percentage of emails that were delivered with two or more delivery attempts. This rate does not include delayed emails that could not be delivered.","delayed_first_attempt_rate":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The percentage of emails that were delivered with two or more delivery attempts or failed to deliver after repeated attempts. The denominator is the processed_count"},"children":[]}]}]}]}}},"components/schemas/github.com-mailgun-analytics-client-golang-FilterAttribute":{"id":"components/schemas/github.com-mailgun-analytics-client-golang-FilterAttribute","kind":"json-schema","title":"github.com-mailgun-analytics-client-golang-FilterAttribute","data":{"type":"string","enum":["bot","country","ip_pool","recipient_domain","recipient_provider","ip","domain","tag","device","subaccount"],"description":"Filter attribute","x-enumDescriptions":{"bot":"The automated system that engaged with the email, e.g. apple, gmail","country":"Country from which the email was sent, e.g. US, FR, MX","ip_pool":"IP pool used to send the email","recipient_domain":"Recipient domain, e.g. gmail.com","recipient_provider":"Email service provider of the recipient, e.g. Gmail, Outlook US, Apple","ip":"IP address used to send the email","domain":"Domain used to send the email, e.g. example.com","tag":"Custom tag attached to the message","device":"Type of device used to send the email, e.g. mobile, desktop","subaccount":"Subaccount identifier"}}},"components/schemas/github.com-mailgun-analytics-client-golang-FilterComparator":{"id":"components/schemas/github.com-mailgun-analytics-client-golang-FilterComparator","kind":"json-schema","title":"github.com-mailgun-analytics-client-golang-FilterComparator","data":{"type":"string","enum":["=","!=","contains","not contains"],"description":"Filter comparator","x-enumDescriptions":{"=":"Equals","!=":"Not equals","contains":"Contains","not contains":"Does not contain"}}},"components/schemas/github.com-mailgun-analytics-client-golang-LabeledValue":{"id":"components/schemas/github.com-mailgun-analytics-client-golang-LabeledValue","kind":"json-schema","title":"github.com-mailgun-analytics-client-golang-LabeledValue","data":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}},"required":["label","value"]}},"components/schemas/github.com-mailgun-analytics-client-golang-FilterPredicate":{"id":"components/schemas/github.com-mailgun-analytics-client-golang-FilterPredicate","kind":"json-schema","title":"github.com-mailgun-analytics-client-golang-FilterPredicate","data":{"type":"object","properties":{"attribute":{"$ref":"#/components/schemas/github.com-mailgun-analytics-client-golang-FilterAttribute"},"comparator":{"$ref":"#/components/schemas/github.com-mailgun-analytics-client-golang-FilterComparator"},"values":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-analytics-client-golang-LabeledValue"}}},"required":["attribute","comparator"]}},"components/schemas/github.com-mailgun-analytics-client-golang-FilterPredicateGroup":{"id":"components/schemas/github.com-mailgun-analytics-client-golang-FilterPredicateGroup","kind":"json-schema","title":"github.com-mailgun-analytics-client-golang-FilterPredicateGroup","data":{"type":"object","properties":{"AND":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-analytics-client-golang-FilterPredicate"}}},"required":["AND"]}},"components/schemas/github.com-mailgun-analytics-client-golang-Query":{"id":"components/schemas/github.com-mailgun-analytics-client-golang-Query","kind":"json-schema","title":"github.com-mailgun-analytics-client-golang-Query","data":{"type":"object","properties":{"start":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A start date (default: 7 days before current time). Must be in RFC 2822 format: https://datatracker.ietf.org/doc/html/rfc2822.html#page-14"},"children":[]}]}]}]},"end":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An end date (default: current time). Must be in RFC 2822 format: https://datatracker.ietf.org/doc/html/rfc2822.html#page-14"},"children":[]}]}]}]},"resolution":{"type":"string","description":"A resolution in the format of 'day' 'hour' 'month'. Default is day."},"duration":{"type":"string","description":"A duration in the format of '1d' '2h' '2m'. If duration is provided then it is calculated from the end date and overwrites the start date."},"dimensions":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-analytics-client-golang-DimensionName"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attributes of the metric data such as 'subaccount'.  See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/reporting/dimensions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dimensions"},"children":[]}]}]}]}]},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-analytics-client-golang-Metric"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the metrics to receive the stats for such as 'processed_count'. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/reporting/metric-definitions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"metrics"},"children":[]}]}]}]}]},"filter":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-analytics-client-golang-FilterPredicateGroup"}],"description":"Filters to apply to the query."},"include_subaccounts":{"type":"boolean","description":"Include stats from all subaccounts."},"include_aggregates":{"type":"boolean","description":"Include top-level aggregate metrics."}}}},"components/schemas/github.com-mailgun-analytics-internal-api-UsageMetrics":{"id":"components/schemas/github.com-mailgun-analytics-internal-api-UsageMetrics","kind":"json-schema","title":"github.com-mailgun-analytics-internal-api-UsageMetrics","data":{"type":"object","properties":{"processed_count":{"type":["integer","null"],"format":"int64"},"email_validation_count":{"type":["integer","null"],"format":"int64"},"email_validation_public_count":{"type":["integer","null"],"format":"int64"},"email_validation_valid_count":{"type":["integer","null"],"format":"int64"},"email_validation_single_count":{"type":["integer","null"],"format":"int64"},"email_validation_bulk_count":{"type":["integer","null"],"format":"int64"},"email_validation_list_count":{"type":["integer","null"],"format":"int64"},"email_validation_mailgun_count":{"type":["integer","null"],"format":"int64"},"email_validation_mailjet_count":{"type":["integer","null"],"format":"int64"},"email_preview_count":{"type":["integer","null"],"format":"int64"},"email_preview_failed_count":{"type":["integer","null"],"format":"int64"},"link_validation_count":{"type":["integer","null"],"format":"int64"},"link_validation_failed_count":{"type":["integer","null"],"format":"int64"},"seed_test_count":{"type":["integer","null"],"format":"int64"},"ip_blocklist_monitoring_count":{"type":["integer","null"],"format":"int64"},"domain_blocklist_monitoring_count":{"type":["integer","null"],"format":"int64"}}}},"components/schemas/github.com-mailgun-analytics-internal-api-UsageItem":{"id":"components/schemas/github.com-mailgun-analytics-internal-api-UsageItem","kind":"json-schema","title":"github.com-mailgun-analytics-internal-api-UsageItem","data":{"type":"object","properties":{"dimensions":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-analytics-client-golang-Dimension"}},"metrics":{"$ref":"#/components/schemas/github.com-mailgun-analytics-internal-api-UsageMetrics"}}}},"components/schemas/github.com-mailgun-analytics-internal-api-UsageAggregates":{"id":"components/schemas/github.com-mailgun-analytics-internal-api-UsageAggregates","kind":"json-schema","title":"github.com-mailgun-analytics-internal-api-UsageAggregates","data":{"type":"object","properties":{"metrics":{"$ref":"#/components/schemas/github.com-mailgun-analytics-internal-api-UsageMetrics"}},"required":["metrics"]}},"components/schemas/github.com-mailgun-analytics-internal-api-UsageMetricsResponse":{"id":"components/schemas/github.com-mailgun-analytics-internal-api-UsageMetricsResponse","kind":"json-schema","title":"github.com-mailgun-analytics-internal-api-UsageMetricsResponse","data":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"},"resolution":{"type":"string"},"duration":{"type":"string"},"dimensions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/github.com-mailgun-analytics-client-golang-Pagination"},"items":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-analytics-internal-api-UsageItem"}},"aggregates":{"$ref":"#/components/schemas/github.com-mailgun-analytics-internal-api-UsageAggregates"}},"required":["items"]}},"components/schemas/github.com-mailgun-analytics-client-golang-UsageDimensionName":{"id":"components/schemas/github.com-mailgun-analytics-client-golang-UsageDimensionName","kind":"json-schema","title":"github.com-mailgun-analytics-client-golang-UsageDimensionName","data":{"type":"string","enum":["subaccount","time"],"description":"Usage Dimension","x-enumDescriptions":{"subaccount":"Subaccount identifier","time":"The time that your events occurred"}}},"components/schemas/github.com-mailgun-analytics-client-golang-UsageMetric":{"id":"components/schemas/github.com-mailgun-analytics-client-golang-UsageMetric","kind":"json-schema","title":"github.com-mailgun-analytics-client-golang-UsageMetric","data":{"type":"string","enum":["email_validation_count","email_validation_public_count","email_validation_valid_count","email_validation_single_count","email_validation_bulk_count","email_validation_list_count","email_validation_mailgun_count","email_validation_mailjet_count","email_preview_count","email_preview_failed_count","link_validation_count","link_validation_failed_count","seed_test_count","ip_blocklist_monitoring_count","domain_blocklist_monitoring_count","accessibility_count","accessibility_failed_count","image_validation_count","image_validation_failed_count","spam_content_check_count","spam_content_check_failed_count","archived_count","processed_count"],"description":"Usage Metric","x-enumDescriptions":{"email_validation_count":"Total number of email validations performed","email_validation_public_count":"Number of email validations performed using the public API","email_validation_valid_count":"Number of email validations that returned a valid result","email_validation_single_count":"Number of single email validations performed","email_validation_bulk_count":"Number of bulk email validations performed","email_validation_list_count":"Number of email list validations performed","email_validation_mailgun_count":"Number of email validations performed using Mailgun's validation service","email_validation_mailjet_count":"Number of email validations performed using Mailjet's validation service","email_preview_count":"Total number of email previews generated","email_preview_failed_count":"Number of failed email preview generation attempts","link_validation_count":"Total number of link validations performed","link_validation_failed_count":"Number of link validations that failed","seed_test_count":"Number of seed tests conducted","ip_blocklist_monitoring_count":"Number of IP blocklist monitoring checks performed","domain_blocklist_monitoring_count":"Number of domain blocklist monitoring checks performed","accessibility_count":"Total number of accessibility checks performed","accessibility_failed_count":"Number of accessibility checks that failed","image_validation_count":"Total number of image validations performed","image_validation_failed_count":"Number of image validations that failed","spam_content_check_count":"Total number of spam content checks performed","spam_content_check_failed_count":"Number of spam content checks that failed","archived_count":"Number of items archived","processed_count":"Messages processed after being accepted. Processed messages are billed to your account at the end of the month."}}},"components/schemas/github.com-mailgun-analytics-client-golang-UsageQuery":{"id":"components/schemas/github.com-mailgun-analytics-client-golang-UsageQuery","kind":"json-schema","title":"github.com-mailgun-analytics-client-golang-UsageQuery","data":{"type":"object","properties":{"start":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A start date (default: 7 days before current time). Must be in RFC 2822 format: https://datatracker.ietf.org/doc/html/rfc2822.html#page-14"},"children":[]}]}]}]},"end":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An end date (default: current time). Must be in RFC 2822 format: https://datatracker.ietf.org/doc/html/rfc2822.html#page-14"},"children":[]}]}]}]},"resolution":{"type":"string","description":"A resolution in the format of 'day' 'hour' 'month'. Default is day."},"duration":{"type":"string","description":"A duration in the format of '1d' '2h' '2m'. If duration is provided then it is calculated from the end date and overwrites the start date."},"dimensions":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-analytics-client-golang-UsageDimensionName"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attributes of the metric data such as 'subaccount'.  See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/reporting/dimensions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dimensions"},"children":[]}]}]}]}]},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-analytics-client-golang-UsageMetric"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the metrics to receive the stats for such as 'processed_count'."},"children":[]}]}]}]},"filter":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-analytics-client-golang-FilterPredicateGroup"}],"description":"Filters to apply to the query."},"include_subaccounts":{"type":"boolean","description":"Include stats from all subaccounts."},"include_aggregates":{"type":"boolean","description":"Include top-level aggregate metrics."}}}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Account":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Account","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-Account","data":{"type":"object","properties":{"parent-id":{"type":"string"},"id":{"type":"string"}}}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Campaign":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Campaign","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-Campaign","data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-DeliveryStatus":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-DeliveryStatus","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-DeliveryStatus","data":{"type":"object","properties":{"message":{"type":"string"},"attempt-no":{"type":"integer","format":"int32"},"code":{"type":"integer","format":"int32"},"bounce-type":{"type":"string"},"description":{"type":"string"},"session-seconds":{"type":"number","format":"float"},"retry-seconds":{"type":"integer","format":"int32"},"enhanced-code":{"type":"string"},"mx-host":{"type":"string"},"certificate-verified":{"type":"boolean"},"tls":{"type":"boolean"},"utf8":{"type":"boolean"},"first-delivery-attempt-seconds":{"type":"number","format":"float"},"last-code":{"type":"integer","format":"int32"},"last-message":{"type":"string"}}}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Domain":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Domain","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-Domain","data":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Envelope":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Envelope","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-Envelope","data":{"type":"object","properties":{"sender":{"type":"string"},"transport":{"type":"string"},"sending-ip":{"type":"string"},"targets":{"type":"string"},"i-ip-pool-id":{"type":"string"}}}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Storage":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Storage","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-Storage","data":{"type":"object","properties":{"region":{"type":"string"},"env":{"type":"string"},"key":{"type":"string"},"url":{"type":"array","items":{"type":"string"}}}}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Template":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Template","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-Template","data":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"},"is-text":{"type":"boolean"}}}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-MessageHeaders":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-MessageHeaders","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-MessageHeaders","data":{"type":"object","properties":{"to":{"type":"string"},"message-id":{"type":"string"},"from":{"type":"string"},"subject":{"type":"string"}}}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Attachment":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Attachment","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-Attachment","data":{"type":"object","properties":{"filename":{"type":"string"},"content-type":{"type":"string"},"size":{"type":"integer","format":"int32"}}}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Message":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Message","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-Message","data":{"type":"object","properties":{"headers":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-MessageHeaders"},{"type":"null"}]},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-Attachment"}},"recipients":{"type":"array","items":{"type":"string"}},"size":{"type":"integer","format":"int32"},"scheduled-for":{"type":"integer","format":"int64"}}}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Flags":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Flags","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-Flags","data":{"type":"object","properties":{"is-authenticated":{"type":"boolean"},"is-system-test":{"type":"boolean"},"is-routed":{"type":"boolean"},"is-amp":{"type":"boolean"},"is-test-mode":{"type":"boolean"},"is-delayed-bounce":{"type":"boolean"},"is-callback":{"type":"boolean"},"is-encrypted":{"type":"boolean"},"is-webhook":{"type":"boolean"}},"required":["is-authenticated","is-system-test","is-routed","is-test-mode","is-delayed-bounce","is-callback","is-webhook"]}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-GeoLocation":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-GeoLocation","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-GeoLocation","data":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"region":{"type":"string"},"timezone":{"type":"string"}}}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-ClientInfo":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-ClientInfo","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-ClientInfo","data":{"type":"object","properties":{"client-name":{"type":"string"},"client-os":{"type":"string"},"client-type":{"type":"string"},"device-type":{"type":"string"},"user-agent":{"type":"string"},"ip":{"type":"string"},"bot":{"type":"string"}}}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-RoutesMatch":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-RoutesMatch","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-RoutesMatch","data":{"type":"object","properties":{"recipient":{"type":"string"}}}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Routes":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Routes","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-Routes","data":{"type":"object","properties":{"actions":{"type":"string"},"description":{"type":"string"},"expression":{"type":"string"},"id":{"type":"string"},"priority":{"type":"integer","format":"int32"},"match":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-RoutesMatch"},{"type":"null"}]}}}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-MailingList":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-MailingList","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-MailingList","data":{"type":"object","properties":{"address":{"type":"string"},"list-id":{"type":"string"},"sid":{"type":"string"}}}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-LogEvent":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-LogEvent","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-LogEvent","data":{"type":"object","properties":{"id":{"type":"string"},"event":{"type":"string"},"@timestamp":{"type":"string"},"account":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-Account"},{"type":"null"}]},"campaigns":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-Campaign"}},"tags":{"type":"array","items":{"type":"string"}},"method":{"type":"string"},"originating-ip":{"type":"string"},"api-key-id":{"type":"string"},"delivered-at":{"type":"string"},"delivery-status":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-DeliveryStatus"},{"type":"null"}]},"i-delivery-optimizer":{"type":"string"},"domain":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-Domain"},{"type":"null"}]},"recipient":{"type":"string"},"recipient-domain":{"type":"string"},"recipient-provider":{"type":"string"},"envelope":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-Envelope"},{"type":"null"}]},"storage":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-Storage"},{"type":"null"}]},"template":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-Template"},{"type":"null"}]},"log-level":{"type":"string"},"user-variables":{"type":"string"},"message":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-Message"},{"type":"null"}]},"flags":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-Flags"},{"type":"null"}]},"primary-dkim":{"type":"string"},"ip":{"type":"string"},"geolocation":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-GeoLocation"},{"type":"null"}]},"client-info":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-ClientInfo"},{"type":"null"}]},"severity":{"type":"string"},"reason":{"type":"string"},"routes":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-Routes"},{"type":"null"}]},"mailing-list":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-MailingList"},{"type":"null"}]},"url":{"type":"string"}},"required":["id","event","@timestamp","domain"]}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-PagingResponse":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-PagingResponse","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-PagingResponse","data":{"type":"object","properties":{"previous":{"type":"string","description":"Token to previous page"},"next":{"type":"string","description":"Token to next page"},"first":{"type":"string","description":"Token to first page"},"last":{"type":"string","description":"Token to last page"},"total":{"type":"integer","format":"int64","description":"Total number of items"}}}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Aggregates":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Aggregates","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-Aggregates","data":{"type":"object","properties":{"all":{"type":"integer","format":"int64"},"metrics":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}}}}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-LogsResponse":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-LogsResponse","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-LogsResponse","data":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-LogEvent"}},"pagination":{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-PagingResponse"},"aggregates":{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-Aggregates"}},"required":["start","end","items","pagination"]}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Event":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Event","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-Event","data":{"type":"string","enum":["accepted","delivered","failed","opened","unique_opened","clicked","unique_clicked","unsubscribed","complained","rejected","stored","email_validation","list_uploaded","list_member_uploaded","list_member_upload_error","trapped"],"description":"Events","x-enumDescriptions":{"accepted":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logs with event=accepted"},"children":[]}]}]}],"delivered":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logs with event=delivered"},"children":[]}]}]}],"failed":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logs with event=failed"},"children":[]}]}]}],"opened":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logs with event=opened"},"children":[]}]}]}],"unique_opened":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logs with event=opened unique per message-id, recipient combination"},"children":[]}]}]}],"clicked":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logs with event=clicked"},"children":[]}]}]}],"unique_clicked":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logs with event=clicked unique per message-id, recipient combination"},"children":[]}]}]}],"unsubscribed":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logs with event=unsubscribed"},"children":[]}]}]}],"complained":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logs with event=complained"},"children":[]}]}]}],"rejected":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logs with event=rejected"},"children":[]}]}]}],"stored":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logs with event=stored"},"children":[]}]}]}],"email_validation":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logs with event=email_validation"},"children":[]}]}]}],"list_uploaded":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logs with event=list_uploaded"},"children":[]}]}]}],"list_member_uploaded":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logs with event=list_member_uploaded"},"children":[]}]}]}],"list_member_upload_error":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logs with event=list_member_upload_error"},"children":[]}]}]}],"trapped":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logs with event=trapped"},"children":[]}]}]}]}}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-MetricEvent":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-MetricEvent","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-MetricEvent","data":{"type":"string","enum":["accepted_incoming","accepted_outgoing","accepted","delivered_smtp","delivered_http","delivered_optimized","delivered","stored","opened","clicked","unique_opened","unique_clicked","complained","unsubscribed","failed","processed","sent","temporary_failed","permanent_failed","esp_block","temporary_failed_esp_block","permanent_failed_esp_block","webhook_failure","permanent_failed_optimized","permanent_failed_old","bounced","hard_bounces","soft_bounces","delayed_bounce","suppressed_bounces","suppressed_unsubscribed","suppressed_complaints","delivered_first_attempt","delivered_subsequent","delivered_two_plus_attempts","delayed_first_attempt"],"description":"Metric Events","x-enumDescriptions":{"accepted_incoming":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accepted events where flags.is_authenticated is false"},"children":[]}]}]}],"accepted_outgoing":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accepted events where flags.is_authenticated is true"},"children":[]}]}]}],"accepted":"all accepted events","delivered_smtp":"delivered events where envelope.transport is smtp","delivered_http":"delivered events where envelope.transport is http","delivered_optimized":"delivered events where i-delivery-optimizer is set","delivered":"all delivered events","stored":"all stored events","opened":"all opened events","clicked":"all clicked events","unique_opened":"opened events that are unique for the message id and recipient","unique_clicked":"clicked events that are unique for the message id and recipient","complained":"all complained events","unsubscribed":"all unsubscribed events","failed":"all failed events. Does not include internal failures or failures associated with webhooks only delivery failures","processed":"all processed events (delivered or failed events)","sent":"all sent events (deliverd or failed events not including suppressions or webhooks)","temporary_failed":"failure events where the severity is temporary","permanent_failed":"failure events where the severity is permanent","esp_block":"failure events where the failure reason is espblock","temporary_failed_esp_block":"failure events where the failure reason is espblock and the severity is temporary","permanent_failed_esp_block":"failure events where the failure reason is espblock and the severity is permanent","webhook_failure":"failed webhook events","permanent_failed_optimized":"failed events where the severity is permanent and the ","permanent_failed_old":"failed events where the severity is permanent","bounced":"all permanent failed events other than suppresions or webhook failures","hard_bounces":"failed events where delivery-status.bounce-type is hard","soft_bounces":"failed events where delivery-status.bounce-type is soft","delayed_bounce":"permanent failed events where flags.is-delayed-bounce is true","suppressed_bounces":"permanent failed events where reason is suppress-bounce","suppressed_unsubscribed":"permanent failed events where reason is suppress-unsubscribe","suppressed_complaints":"permanent failed events where reason is suppress-complaint","delivered_first_attempt":"delivered events that succeeded on the first attempt","delivered_subsequent":"delivered events that failed on the first attempt but were eventually successful","delivered_two_plus_attempts":"delivered events that required two or more delivery attempts","delayed_first_attempt":"delivered events that failed the first attempt or failed events where reason is old"}}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-FilterAttribute":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-FilterAttribute","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-FilterAttribute","data":{"type":"string","enum":["id","domain","ip","ip_pool","recipient_domain","recipient_provider","country","bot","device","subaccount","event","attachment_filename","from","message_id","subject","mailing_list_address","to","size","recipient","tag","severity","user_variables","delivered_at","delivery_status_code","delivery_status_bounce_type","delivery_status_message","is_routed","i_classification_rule_id","i_classification_group_id","recipients"],"description":"Filter Attribute","x-enumDescriptions":{"id":"Filter on a specific id of a log message. Mostly used to retrieve a specific log found in Kibana","domain":"Filter on a given sender domain used for delivery","ip":"Filter on the ip address used for delivery","ip_pool":"Filter on the name of the ip pool used for delivery","recipient_domain":"Filter on the domain of the email recipient","recipient_provider":"Filter on the email provider of the recipient","country":"For open and click events, filter on the country of the email recipient","bot":"For open and click events, filter on the client-info.bot field which tracks if an actual person triggered the event, or an email client program","device":"For open and click events, filter on the device the email recipient was using when openning or clicking on the email.","subaccount":"Filter to events generated for a subaccount","event":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for a specific event by name. Since "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metric_events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be comprised of multiple events, this can be used to drill into a specific event."},"children":[]}]}]}],"attachment_filename":"Filter delivered events for those containing an attachment with a given filename","from":"Filter for events with a given from address","message_id":"Filter for events with a given message-id header. A message ID ties together the accepted, delivered, and any failed events over the lifecycle of the email","subject":"Filter for emails with a given subject","mailing_list_address":"Filter for emails with a given mailing list address","to":"Filter for emails with a given to field. This can contain a mailing list and can also contain the display name of the email recipient such as John Doe","size":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter emails based on size in bytes. This field must use < or > as the comparator"},"children":[]}]}]}],"recipient":"Filter for emails with a given recipient, which is an email address","tag":"Filter for emails with a given tag (or tags if using the contains comparator)","severity":"Filter failure events based on their severity. Possible values are either temporary or permanent","user_variables":"Filter on user defined variables associated with the email. User variables are stored as a flat JSON string and filters search against keys or values","delivered_at":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for deliveries that occured before or after a given time, given as RFC1123Z. Comparator must be < or >"},"children":[]}]}]}],"delivery_status_code":"Filter for failure or delivery events with a specific delivery code","delivery_status_bounce_type":"Filter for a given bounce type. Either soft or hard","delivery_status_message":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for a status message. Like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delivery_status_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but checks against a status message string"},"children":[]}]}]}],"is_routed":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter on the flags.is_routed boolean flag"},"children":[]}]}]}],"i_classification_rule_id":"Filter on the i-classification.rule-id associated with a bounce classification rule","i_classification_group_id":"Filter on the i-classification.group-id associated with a bounce classification group","recipients":"Filter on the list of email message recipients. Must use the \"contains\" or \"not contains\" comparators"}}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-LabeledValue":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-LabeledValue","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-LabeledValue","data":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}},"required":["label","value"]}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-FilterPredicate":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-FilterPredicate","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-FilterPredicate","data":{"type":"object","properties":{"attribute":{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-FilterAttribute"},"comparator":{"type":"string"},"values":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-LabeledValue"}}},"required":["attribute","comparator","values"]}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-FilterPredicateGroup":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-FilterPredicateGroup","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-FilterPredicateGroup","data":{"type":"object","properties":{"AND":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-FilterPredicate"}}},"required":["AND"]}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Pagination":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-Pagination","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-Pagination","data":{"type":"object","properties":{"sort":{"type":"string","description":"Colon-separated value indicating column name and sort direction e.g. 'timestamp:desc'."},"token":{"type":"string","description":"A token to the requested page."},"limit":{"type":"integer","format":"int32","description":"The maximum number of items returned (100 max)."}}}},"components/schemas/github.com-mailgun-logs-api-pkg-api-model-LogsRequest":{"id":"components/schemas/github.com-mailgun-logs-api-pkg-api-model-LogsRequest","kind":"json-schema","title":"github.com-mailgun-logs-api-pkg-api-model-LogsRequest","data":{"type":"object","properties":{"start":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start date (default: 1 day before current time). Must be in RFC 2822 format: https://datatracker.ietf.org/doc/html/rfc2822.html#page-14"},"children":[]}]}]}]},"end":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end date (default: current time). Must be in RFC 2822 format: https://datatracker.ietf.org/doc/html/rfc2822.html#page-14"},"children":[]}]}]}]},"duration":{"type":"string","description":"A duration in the format of '1d' '2h'. If duration is provided then it is calculated from the end date and overwrites the start date."},"events":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-Event"},"description":"The set of events to include."},"metric_events":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-MetricEvent"},"description":"Optional set of analytics metric events. Will be converted into corresponding events."},"filter":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-FilterPredicateGroup"}],"description":"Filters to apply to the query."},"include_subaccounts":{"type":"boolean","description":"Include logs from all subaccounts."},"include_totals":{"type":"boolean","description":"Include total number of log entries."},"pagination":{"$ref":"#/components/schemas/github.com-mailgun-logs-api-pkg-api-model-Pagination"}},"required":["duration"]}},"components/schemas/github.com-mailgun-tags-api-pkg-api-model-CustomTime":{"id":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-CustomTime","kind":"json-schema","title":"github.com-mailgun-tags-api-pkg-api-model-CustomTime","data":{"type":"object"}},"components/schemas/github.com-mailgun-analytics-client-golang-Metrics":{"id":"components/schemas/github.com-mailgun-analytics-client-golang-Metrics","kind":"json-schema","title":"github.com-mailgun-analytics-client-golang-Metrics","data":{"type":"object","properties":{"accepted_incoming_count":{"type":"integer","format":"int64"},"accepted_outgoing_count":{"type":"integer","format":"int64"},"accepted_count":{"type":"integer","format":"int64"},"delivered_smtp_count":{"type":"integer","format":"int64"},"delivered_http_count":{"type":"integer","format":"int64"},"delivered_optimized_count":{"type":"integer","format":"int64"},"delivered_count":{"type":"integer","format":"int64"},"stored_count":{"type":"integer","format":"int64"},"sent_count":{"type":"integer","format":"int64"},"opened_count":{"type":"integer","format":"int64"},"clicked_count":{"type":"integer","format":"int64"},"unique_opened_count":{"type":"integer","format":"int64"},"unique_clicked_count":{"type":"integer","format":"int64"},"unsubscribed_count":{"type":"integer","format":"int64"},"complained_count":{"type":"integer","format":"int64"},"failed_count":{"type":"integer","format":"int64"},"temporary_failed_count":{"type":"integer","format":"int64"},"permanent_failed_count":{"type":"integer","format":"int64"},"esp_block_count":{"type":"integer","format":"int64"},"temporary_failed_esp_block_count":{"type":"integer","format":"int64"},"permanent_failed_esp_block_count":{"type":"integer","format":"int64"},"rate_limit_count":{"type":"integer","format":"int64"},"webhook_count":{"type":"integer","format":"int64"},"permanent_failed_optimized_count":{"type":"integer","format":"int64"},"permanent_failed_old_count":{"type":"integer","format":"int64"},"bounced_count":{"type":"integer","format":"int64"},"hard_bounces_count":{"type":"integer","format":"int64"},"soft_bounces_count":{"type":"integer","format":"int64"},"delayed_bounce_count":{"type":"integer","format":"int64"},"suppressed_bounces_count":{"type":"integer","format":"int64"},"suppressed_unsubscribed_count":{"type":"integer","format":"int64"},"suppressed_complaints_count":{"type":"integer","format":"int64"},"delivered_first_attempt_count":{"type":"integer","format":"int64"},"delayed_first_attempt_count":{"type":"integer","format":"int64"},"delivered_subsequent_count":{"type":"integer","format":"int64"},"delivered_two_plus_attempts_count":{"type":"integer","format":"int64"},"processed_count":{"type":"integer","format":"int64"},"delivered_rate":{"type":"string"},"opened_rate":{"type":"string"},"clicked_rate":{"type":"string"},"unique_opened_rate":{"type":"string"},"unique_clicked_rate":{"type":"string"},"unsubscribed_rate":{"type":"string"},"complained_rate":{"type":"string"},"bounce_rate":{"type":"string"},"hard_bounce_rate":{"type":"string"},"soft_bounce_rate":{"type":"string"},"fail_rate":{"type":"string"},"permanent_fail_rate":{"type":"string"},"temporary_fail_rate":{"type":"string"},"delayed_rate":{"type":"string"},"email_validation_count":{"type":"integer","format":"int64"},"email_validation_public_count":{"type":"integer","format":"int64"},"email_validation_valid_count":{"type":"integer","format":"int64"},"email_validation_single_count":{"type":"integer","format":"int64"},"email_validation_bulk_count":{"type":"integer","format":"int64"},"email_validation_list_count":{"type":"integer","format":"int64"},"email_validation_mailgun_count":{"type":"integer","format":"int64"},"email_validation_mailjet_count":{"type":"integer","format":"int64"},"email_preview_count":{"type":"integer","format":"int64"},"email_preview_failed_count":{"type":"integer","format":"int64"},"link_validation_count":{"type":"integer","format":"int64"},"link_validation_failed_count":{"type":"integer","format":"int64"},"seed_test_count":{"type":"integer","format":"int64"},"accessibility_count":{"type":"integer","format":"int64"},"accessibility_failed_count":{"type":"integer","format":"int64"},"image_validation_count":{"type":"integer","format":"int64"},"image_validation_failed_count":{"type":"integer","format":"int64"}}}},"components/schemas/github.com-mailgun-tags-api-pkg-api-model-Tag":{"id":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-Tag","kind":"json-schema","title":"github.com-mailgun-tags-api-pkg-api-model-Tag","data":{"type":"object","properties":{"account_id":{"type":"string"},"parent_account_id":{"type":"string"},"tag":{"type":"string"},"description":{"type":"string"},"first_seen":{"$ref":"#/components/schemas/github.com-mailgun-tags-api-pkg-api-model-CustomTime"},"last_seen":{"$ref":"#/components/schemas/github.com-mailgun-tags-api-pkg-api-model-CustomTime"},"metrics":{"$ref":"#/components/schemas/github.com-mailgun-analytics-client-golang-Metrics"},"account_name":{"type":"string"}},"required":["account_id","parent_account_id","tag","description","account_name"]}},"components/schemas/github.com-mailgun-tags-api-pkg-api-model-Pagination":{"id":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-Pagination","kind":"json-schema","title":"github.com-mailgun-tags-api-pkg-api-model-Pagination","data":{"type":"object","properties":{"sort":{"type":"string","description":"Colon-separated value indicating column name and sort direction e.g. 'lastseen:desc'."},"skip":{"type":"integer","format":"int64","description":"The number of items to skip over when satisfying the request. To get the first page of data set skip to zero.  Then increment the skip by the limit for subsequent calls."},"limit":{"type":"integer","format":"int64","description":"The maximum number of items returned in the response. Default 10 max 1000."},"total":{"type":"integer","format":"int64","description":"The total number of tags matching the search criteria."},"include_total":{"type":"boolean","description":"Boolean indicating whether or not to include total number of items. Default false."}}}},"components/schemas/github.com-mailgun-tags-api-pkg-api-model-TagsResponse":{"id":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-TagsResponse","kind":"json-schema","title":"github.com-mailgun-tags-api-pkg-api-model-TagsResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-tags-api-pkg-api-model-Tag"}},"pagination":{"$ref":"#/components/schemas/github.com-mailgun-tags-api-pkg-api-model-Pagination"}},"required":["items"]}},"components/schemas/github.com-mailgun-tags-api-pkg-api-model-ListTagsRequest":{"id":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-ListTagsRequest","kind":"json-schema","title":"github.com-mailgun-tags-api-pkg-api-model-ListTagsRequest","data":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/github.com-mailgun-tags-api-pkg-api-model-Pagination"},"include_subaccounts":{"type":"boolean","description":"Boolean indicating whether or not to include data from all subaccounts. Default false."},"include_metrics":{"type":"boolean","description":"Boolean indicating whether or not to include metrics for tags. Default false.  When true max limit is 20."},"tag":{"type":"string","description":"The tag or tag prefix."}}}},"components/schemas/github.com-mailgun-tags-api-pkg-api-model-UpdateTagRequest":{"id":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-UpdateTagRequest","kind":"json-schema","title":"github.com-mailgun-tags-api-pkg-api-model-UpdateTagRequest","data":{"type":"object","properties":{"tag":{"type":"string","description":"The tag to update."},"description":{"type":"string","description":"The updated tag description."}}}},"components/schemas/github.com-mailgun-tags-api-pkg-api-model-DeleteTagRequest":{"id":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-DeleteTagRequest","kind":"json-schema","title":"github.com-mailgun-tags-api-pkg-api-model-DeleteTagRequest","data":{"type":"object","properties":{"tag":{"type":"string","description":"The tag to delete."}}}},"components/schemas/github.com-mailgun-tags-api-pkg-api-model-TagLimitCountResponse":{"id":"components/schemas/github.com-mailgun-tags-api-pkg-api-model-TagLimitCountResponse","kind":"json-schema","title":"github.com-mailgun-tags-api-pkg-api-model-TagLimitCountResponse","data":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int64"},"limit_reached":{"type":"boolean"}},"required":["limit","count","limit_reached"]}},"components/schemas/github.com-mailgun-thresholds-api-AlertChannel":{"id":"components/schemas/github.com-mailgun-thresholds-api-AlertChannel","kind":"json-schema","title":"github.com-mailgun-thresholds-api-AlertChannel","data":{"type":"string","enum":["email","slack","webhook"],"description":"Alert Channel","x-enumDescriptions":{"email":"Email","slack":"Slack","webhook":"Webhook"}}},"components/schemas/github.com-mailgun-thresholds-api-Dimension":{"id":"components/schemas/github.com-mailgun-thresholds-api-Dimension","kind":"json-schema","title":"github.com-mailgun-thresholds-api-Dimension","data":{"type":"string","enum":["domain","ip","ip_pool","recipient_provider","subaccount"],"description":"Dimension","x-enumDescriptions":{"domain":"Sender domain name, e.g. example.com","ip":"Sending IP address","ip_pool":"IP Pool ID","recipient_provider":"Recipient Provider, e.g. Gmail, Other US, etc.","subaccount":"Subaccount name"}}},"components/schemas/github.com-mailgun-thresholds-api-FilterComparator":{"id":"components/schemas/github.com-mailgun-thresholds-api-FilterComparator","kind":"json-schema","title":"github.com-mailgun-thresholds-api-FilterComparator","data":{"type":"string","enum":["=","!=","contains","not contains","<","<=",">",">="],"description":"Filter Comparator","x-enumDescriptions":{"=":"Equal","!=":"Not equal","contains":"Contains","not contains":"Does not contain","<":"Less than","<=":"Less than or equal",">":"Greater than",">=":"Greater than or equal"}}},"components/schemas/github.com-mailgun-thresholds-api-Filter":{"id":"components/schemas/github.com-mailgun-thresholds-api-Filter","kind":"json-schema","title":"github.com-mailgun-thresholds-api-Filter","data":{"type":"object","properties":{"dimension":{"type":"string","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-Dimension"}],"description":"The dimension to filter by."},"comparator":{"type":"string","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-FilterComparator"}],"description":"The comparison operator."},"values":{"type":"array","items":{"type":"string"},"description":"The dimension values to apply to filter."}},"required":["dimension","comparator","values"]}},"components/schemas/github.com-mailgun-thresholds-api-Metric":{"id":"components/schemas/github.com-mailgun-thresholds-api-Metric","kind":"json-schema","title":"github.com-mailgun-thresholds-api-Metric","data":{"type":"string","enum":["hard_bounce_rate","temporary_fail_rate","delivered_rate","complained_rate"],"description":"Metric","x-enumDescriptions":{"hard_bounce_rate":"Hard bounce rate","temporary_fail_rate":"Temporary fail rate","delivered_rate":"Delivery rate","complained_rate":"Complaint rate"}}},"components/schemas/github.com-mailgun-thresholds-api-MetricComparator":{"id":"components/schemas/github.com-mailgun-thresholds-api-MetricComparator","kind":"json-schema","title":"github.com-mailgun-thresholds-api-MetricComparator","data":{"type":"string","enum":["=","!=","<","<=",">",">="],"description":"Metric Comparator","x-enumDescriptions":{"=":"Equal","!=":"Not equal","<":"Less than","<=":"Less than or equal",">":"Greater than",">=":"Greater than or equal"}}},"components/schemas/github.com-mailgun-thresholds-api-SendAlertItem":{"id":"components/schemas/github.com-mailgun-thresholds-api-SendAlertItem","kind":"json-schema","title":"github.com-mailgun-thresholds-api-SendAlertItem","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the alert."},"parent_account_id":{"type":"string","description":"The parent account ID."},"subaccount_id":{"type":"string","description":"The subaccount ID this alert belongs to."},"account_group":{"type":"string","description":"The group this account belongs to."},"name":{"type":"string","description":"A user-friendly name for the alert."},"created_at":{"type":"string","format":"date-time","description":"Timestamp of when the alert was created."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp of when the alert was last updated."},"last_checked":{"type":"string","format":"date-time","description":"Timestamp of the alert was last checked."},"description":{"type":"string","description":"A description of what the alert does."},"alert_channels":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-AlertChannel"},"description":"A list of alert channels to notify."},"filters":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-Filter"},"description":"A list of filters to apply to the alert."},"metric":{"type":"string","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-Metric"}],"description":"The metric being monitored."},"comparator":{"type":"string","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-MetricComparator"}],"description":"The comparison operator."},"limit":{"type":"string","description":"The threshold limit for the alert."},"dimension":{"type":"string","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-Dimension"}],"description":"The dimension to apply to the metric."},"period":{"type":"string","description":"The time period for the metric aggregation in the format of '1h' '1d'."}},"required":["name","created_at","metric","comparator","limit","dimension"]}},"components/schemas/github.com-mailgun-thresholds-api-SendAlertRequest":{"id":"components/schemas/github.com-mailgun-thresholds-api-SendAlertRequest","kind":"json-schema","title":"github.com-mailgun-thresholds-api-SendAlertRequest","data":{"type":"object","properties":{"name":{"type":"string","description":"A user-friendly name for the alert."},"metric":{"type":"string","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-Metric"}],"description":"The metric being monitored."},"comparator":{"type":"string","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-MetricComparator"}],"description":"The comparison operator."},"limit":{"type":"string","description":"The threshold limit for the alert."},"dimension":{"type":"string","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-Dimension"}],"description":"The dimension to apply to the metric."},"alert_channels":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-AlertChannel"},"description":"A list of alert channels to notify."},"filters":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-Filter"},"description":"A list of filters to apply to the alert."},"period":{"type":"string","description":"The time period for the metric aggregation in the format of '1h' '1d'."},"description":{"type":"string","description":"A description of what the alert does."}},"required":["name","metric","comparator","limit","dimension"]}},"components/schemas/github.com-mailgun-thresholds-api-SendAlertListResponse":{"id":"components/schemas/github.com-mailgun-thresholds-api-SendAlertListResponse","kind":"json-schema","title":"github.com-mailgun-thresholds-api-SendAlertListResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-SendAlertItem"},"description":"List of send alerts."},"total":{"type":"integer","format":"int64","description":"Total number of send alerts."}},"required":["items","total"]}},"components/schemas/github.com-mailgun-thresholds-api-LimitMetric":{"id":"components/schemas/github.com-mailgun-thresholds-api-LimitMetric","kind":"json-schema","title":"github.com-mailgun-thresholds-api-LimitMetric","data":{"type":"string","enum":["email_preview_success_count","seed_test_count"],"description":"Limit Metric","x-enumDescriptions":{"email_preview_success_count":"The number of successful email previews","seed_test_count":"The number of inbox placement tests"}}},"components/schemas/github.com-mailgun-thresholds-api-ThresholdLimitItem":{"id":"components/schemas/github.com-mailgun-thresholds-api-ThresholdLimitItem","kind":"json-schema","title":"github.com-mailgun-thresholds-api-ThresholdLimitItem","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the limit."},"parent_account_id":{"type":"string","description":"The parent account ID."},"subaccount_id":{"type":"string","description":"The subaccount ID this limit belongs to."},"account_group":{"type":"string","description":"The group this account belongs to."},"name":{"type":"string","description":"A user-friendly name for the limit."},"created_at":{"type":"string","format":"date-time","description":"Timestamp of when the limit was created."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp of when the limit was last updated."},"last_checked":{"type":"string","format":"date-time","description":"Timestamp of when the limit was last checked."},"description":{"type":"string","description":"A description of what the limit does."},"filters":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-Filter"},"description":"A list of filters to apply to the limit."},"metric":{"type":"string","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-LimitMetric"}],"description":"The metric being monitored."},"comparator":{"type":"string","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-MetricComparator"}],"description":"The comparison operator."},"limit":{"type":"string","description":"The value of the limit."},"dimension":{"type":"string","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-Dimension"}],"description":"The dimension to apply to the metric."},"period":{"type":"string","description":"The time period for the metric aggregation in the format of '1h' '1d'."}},"required":["name","created_at","metric","comparator","limit","dimension"]}},"components/schemas/github.com-mailgun-thresholds-api-LimitRequest":{"id":"components/schemas/github.com-mailgun-thresholds-api-LimitRequest","kind":"json-schema","title":"github.com-mailgun-thresholds-api-LimitRequest","data":{"type":"object","properties":{"name":{"type":"string","description":"A user-friendly name for the limit."},"metric":{"type":"string","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-LimitMetric"}],"description":"The metric being monitored."},"comparator":{"type":"string","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-MetricComparator"}],"description":"The comparison operator."},"limit":{"type":"string","description":"The threshold limit."},"dimension":{"type":"string","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-Dimension"}],"description":"The dimension to apply to the metric."},"filters":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-Filter"},"description":"A list of filters to apply to the limit."},"period":{"type":"string","description":"The time period for the metric aggregation in the format of '1h' '1d'."},"description":{"type":"string","description":"A description of what the limit does."}},"required":["name","metric","comparator","limit","dimension"]}},"components/schemas/github.com-mailgun-thresholds-api-ThresholdLimitListResponse":{"id":"components/schemas/github.com-mailgun-thresholds-api-ThresholdLimitListResponse","kind":"json-schema","title":"github.com-mailgun-thresholds-api-ThresholdLimitListResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-ThresholdLimitItem"},"description":"List of threshold limits."},"total":{"type":"integer","format":"int64","description":"Total number of threshold limits."}},"required":["items","total"]}},"components/schemas/github.com-mailgun-thresholds-api-HitListItem":{"id":"components/schemas/github.com-mailgun-thresholds-api-HitListItem","kind":"json-schema","title":"github.com-mailgun-thresholds-api-HitListItem","data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"triggered":{"type":"boolean"},"expires_at":{"type":"string","format":"date-time"},"latest_value":{"type":"string"},"metric":{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-Metric"},"comparator":{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-MetricComparator"},"limit":{"type":"string"},"parent_account_id":{"type":"string"},"subaccount_id":{"type":"string"},"dimension":{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-Dimension"},"dimension_value":{"type":"string"}},"required":["id","name","created_at","updated_at","triggered","expires_at","latest_value","metric","comparator","limit"]}},"components/schemas/github.com-mailgun-thresholds-api-HitListResponse":{"id":"components/schemas/github.com-mailgun-thresholds-api-HitListResponse","kind":"json-schema","title":"github.com-mailgun-thresholds-api-HitListResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-thresholds-api-HitListItem"}},"total":{"type":"integer","format":"int64"}},"required":["items","total"]}},"components/schemas/github.com-mailgun-alerts-internal-api-ListAlertsEventsResp":{"id":"components/schemas/github.com-mailgun-alerts-internal-api-ListAlertsEventsResp","kind":"json-schema","title":"github.com-mailgun-alerts-internal-api-ListAlertsEventsResp","data":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string"}}},"required":["events"]}},"components/schemas/github.com-mailgun-alerts-channels-Channel":{"id":"components/schemas/github.com-mailgun-alerts-channels-Channel","kind":"json-schema","title":"github.com-mailgun-alerts-channels-Channel","data":{"type":"string","enum":["email","webhook","slack"],"description":"Alert channel type.","x-enumDescriptions":{"email":"email","webhook":"webhook","slack":"Slack"}}},"components/schemas/github.com-mailgun-alerts-internal-settings-DisabledChannel":{"id":"components/schemas/github.com-mailgun-alerts-internal-settings-DisabledChannel","kind":"json-schema","title":"github.com-mailgun-alerts-internal-settings-DisabledChannel","data":{"type":"object","properties":{"disabled_at":{"type":"string","format":"date-time","description":"When the channel was disabled."},"reason":{"type":"string","description":"Why the channel was disabled."}},"required":["disabled_at","reason"]}},"components/schemas/github.com-mailgun-alerts-internal-settings-ChannelSettings":{"id":"components/schemas/github.com-mailgun-alerts-internal-settings-ChannelSettings","kind":"json-schema","title":"github.com-mailgun-alerts-internal-settings-ChannelSettings","data":{"type":"object","properties":{"url":{"type":"string","description":"For webhook channel."},"emails":{"type":"array","items":{"type":"string"},"description":"For email channel"},"channel_ids":{"type":"array","items":{"type":"string"},"description":"For slack channel"},"disabled_channel_ids":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/github.com-mailgun-alerts-internal-settings-DisabledChannel"},"description":"List of disabled Slack channels."}}}},"components/schemas/github.com-mailgun-alerts-internal-settings-EventSettings":{"id":"components/schemas/github.com-mailgun-alerts-internal-settings-EventSettings","kind":"json-schema","title":"github.com-mailgun-alerts-internal-settings-EventSettings","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier for the alert settings record."},"event_type":{"type":"string","description":"The event type that is alerted on. Check GET /v1/alerts/events for possible values."},"channel":{"type":"string","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-alerts-channels-Channel"}],"description":"The delivery channel for the alert."},"settings":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-alerts-internal-settings-ChannelSettings"}],"description":"This object contains channel-specific settings."},"disabled_at":{"type":["string","null"],"format":"date-time","description":"When present, the timestamp indicating when a webhook endpoint was disabled."}},"required":["event_type","channel","settings"]}},"components/schemas/github.com-mailgun-alerts-internal-api-mutateEventSettingReq":{"id":"components/schemas/github.com-mailgun-alerts-internal-api-mutateEventSettingReq","kind":"json-schema","title":"github.com-mailgun-alerts-internal-api-mutateEventSettingReq","data":{"type":"object","properties":{"event_type":{"type":"string","description":"The type of event for which you would like to receive alerts."},"channel":{"type":"string","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-alerts-channels-Channel"}],"description":"The delivery method for the alert."},"settings":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-alerts-internal-settings-ChannelSettings"}],"description":"The details pertaining to the specified channel. Please note that the contents of this object differ per channel type."}},"required":["event_type","channel","settings"]}},"components/schemas/github.com-mailgun-alerts-internal-settings-Webhooks":{"id":"components/schemas/github.com-mailgun-alerts-internal-settings-Webhooks","kind":"json-schema","title":"github.com-mailgun-alerts-internal-settings-Webhooks","data":{"type":"object","properties":{"signing_key":{"type":"string"}},"required":["signing_key"]}},"components/schemas/github.com-mailgun-alerts-internal-settings-Slack":{"id":"components/schemas/github.com-mailgun-alerts-internal-settings-Slack","kind":"json-schema","title":"github.com-mailgun-alerts-internal-settings-Slack","data":{"type":"object","properties":{"token":{"type":"string"},"team_id":{"type":["string","null"]},"team_name":{"type":["string","null"]},"scope":{"type":["string","null"]}},"required":["token","team_id","team_name","scope"]}},"components/schemas/github.com-mailgun-alerts-internal-api-SettingsResponse":{"id":"components/schemas/github.com-mailgun-alerts-internal-api-SettingsResponse","kind":"json-schema","title":"github.com-mailgun-alerts-internal-api-SettingsResponse","data":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-alerts-internal-settings-EventSettings"}},"webhooks":{"$ref":"#/components/schemas/github.com-mailgun-alerts-internal-settings-Webhooks"},"slack":{"$ref":"#/components/schemas/github.com-mailgun-alerts-internal-settings-Slack"}},"required":["events","webhooks","slack"]}},"components/schemas/github.com-mailgun-alerts-internal-api-ResetWebhooksSigningKeyResp":{"id":"components/schemas/github.com-mailgun-alerts-internal-api-ResetWebhooksSigningKeyResp","kind":"json-schema","title":"github.com-mailgun-alerts-internal-api-ResetWebhooksSigningKeyResp","data":{"type":"object","properties":{"signing_key":{"type":"string"}},"required":["signing_key"]}},"components/schemas/github.com-mailgun-alerts-internal-api-TestWebhookRequest":{"id":"components/schemas/github.com-mailgun-alerts-internal-api-TestWebhookRequest","kind":"json-schema","title":"github.com-mailgun-alerts-internal-api-TestWebhookRequest","data":{"type":"object","properties":{"event_type":{"type":"string"},"url":{"type":"string"}},"required":["event_type","url"]}},"components/schemas/github.com-mailgun-alerts-internal-api-TestEmailRequest":{"id":"components/schemas/github.com-mailgun-alerts-internal-api-TestEmailRequest","kind":"json-schema","title":"github.com-mailgun-alerts-internal-api-TestEmailRequest","data":{"type":"object","properties":{"event_type":{"type":"string"},"emails":{"type":"array","items":{"type":"string"}}},"required":["event_type","emails"]}},"components/schemas/github.com-mailgun-alerts-internal-api-TestSlackRequest":{"id":"components/schemas/github.com-mailgun-alerts-internal-api-TestSlackRequest","kind":"json-schema","title":"github.com-mailgun-alerts-internal-api-TestSlackRequest","data":{"type":"object","properties":{"event_type":{"type":"string"},"channel_ids":{"type":"array","items":{"type":"string"},"description":"If omitted would be taken from the event settings"}},"required":["event_type"]}},"components/schemas/github.com-mailgun-alerts-internal-api-SlackChannel":{"id":"components/schemas/github.com-mailgun-alerts-internal-api-SlackChannel","kind":"json-schema","title":"github.com-mailgun-alerts-internal-api-SlackChannel","data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"is_archived":{"type":"boolean"}},"required":["id","name","is_archived"]}},"components/schemas/github.com-mailgun-alerts-internal-api-ListSlackChannelsResp":{"id":"components/schemas/github.com-mailgun-alerts-internal-api-ListSlackChannelsResp","kind":"json-schema","title":"github.com-mailgun-alerts-internal-api-ListSlackChannelsResp","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-alerts-internal-api-SlackChannel"}},"paging":{"$ref":"#/components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingResponse"}},"required":["items","paging"]}},"components/schemas/POST-v3-domainID-unsubscribes-import-multipart-form-data-RequestBody":{"id":"components/schemas/POST-v3-domainID-unsubscribes-import-multipart-form-data-RequestBody","kind":"json-schema","title":"POST-v3-domainID-unsubscribes-import-multipart-form-data-RequestBody","data":{"type":"object","properties":{"file":{"type":"string","description":"CSV file"}},"required":["file"]}},"components/schemas/POST-v3-domainID-bounces-import-multipart-form-data-RequestBody":{"id":"components/schemas/POST-v3-domainID-bounces-import-multipart-form-data-RequestBody","kind":"json-schema","title":"POST-v3-domainID-bounces-import-multipart-form-data-RequestBody","data":{"type":"object","properties":{"file":{"type":"string","description":"CSV file"}},"required":["file"]}},"components/schemas/POST-v3-domainID-complaints-import-multipart-form-data-RequestBody":{"id":"components/schemas/POST-v3-domainID-complaints-import-multipart-form-data-RequestBody","kind":"json-schema","title":"POST-v3-domainID-complaints-import-multipart-form-data-RequestBody","data":{"type":"object","properties":{"file":{"type":"string","description":"CSV file"}},"required":["file"]}},"components/schemas/POST-v3-domainID-whitelists-import-multipart-form-data-RequestBody":{"id":"components/schemas/POST-v3-domainID-whitelists-import-multipart-form-data-RequestBody","kind":"json-schema","title":"POST-v3-domainID-whitelists-import-multipart-form-data-RequestBody","data":{"type":"object","properties":{"file":{"type":"string","description":"CSV file"}},"required":["file"]}},"components/schemas/github.com-mailgun-mime-RFC822Time":{"id":"components/schemas/github.com-mailgun-mime-RFC822Time","kind":"json-schema","title":"github.com-mailgun-mime-RFC822Time","data":{"type":"object"}},"components/schemas/github.com-mailgun-blackbook-model-Bounce":{"id":"components/schemas/github.com-mailgun-blackbook-model-Bounce","kind":"json-schema","title":"github.com-mailgun-blackbook-model-Bounce","data":{"type":"object","properties":{"address":{"type":"string","description":"Email address for the original recipient"},"code":{"type":"string","description":"SMTP error code"},"error":{"type":"string","description":"SMTP error message"},"created_at":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-mime-RFC822Time"}],"description":"Timestamp for when the Bounce event was received in RFC822 format"}},"required":["address","code","error","created_at"]}},"components/schemas/github.com-mailgun-blackbook-api-getBouncesPaginationResponse":{"id":"components/schemas/github.com-mailgun-blackbook-api-getBouncesPaginationResponse","kind":"json-schema","title":"github.com-mailgun-blackbook-api-getBouncesPaginationResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-blackbook-model-Bounce"}},"paging":{"$ref":"#/components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingResponse"}},"required":["items","paging"]}},"components/schemas/github.com-mailgun-blackbook-api-BouncesList":{"id":"components/schemas/github.com-mailgun-blackbook-api-BouncesList","kind":"json-schema","title":"github.com-mailgun-blackbook-api-BouncesList","data":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-blackbook-model-Bounce"}}},"components/schemas/POST-v3-domainID-bounces-application-form-data-RequestBody":{"id":"components/schemas/POST-v3-domainID-bounces-application-form-data-RequestBody","kind":"json-schema","title":"POST-v3-domainID-bounces-application-form-data-RequestBody","data":{"type":"object","properties":{"address":{"type":"string","description":"Valid email address"},"code":{"type":"string","description":"Error code (optional, default: 550)"},"error":{"type":"string","description":"Error description (optional, default: empty string)"},"created_at":{"type":"string","description":"Timestamp of a bounce event in RFC2822 format (optional, default: current time)"}},"required":["address"]}},"components/schemas/github.com-mailgun-blackbook-api-suppressionResponse":{"id":"components/schemas/github.com-mailgun-blackbook-api-suppressionResponse","kind":"json-schema","title":"github.com-mailgun-blackbook-api-suppressionResponse","data":{"type":"object","properties":{"message":{"type":"string","description":"Response message"},"address":{"type":"string","description":"Email address"}},"required":["message","address"]}},"components/schemas/github.com-mailgun-blackbook-model-Unsubscribe":{"id":"components/schemas/github.com-mailgun-blackbook-model-Unsubscribe","kind":"json-schema","title":"github.com-mailgun-blackbook-model-Unsubscribe","data":{"type":"object","properties":{"address":{"type":"string","description":"Email address for the original recipient"},"tags":{"type":"array","items":{"type":"string"},"description":"Any tags present on the message the user clicked Unsubscribe on"},"created_at":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-mime-RFC822Time"}],"description":"Timestamp for when the unsubscribe request was received in RFC822 format"}},"required":["address","tags","created_at"]}},"components/schemas/github.com-mailgun-blackbook-api-getUnsubscribesPaginationResponse":{"id":"components/schemas/github.com-mailgun-blackbook-api-getUnsubscribesPaginationResponse","kind":"json-schema","title":"github.com-mailgun-blackbook-api-getUnsubscribesPaginationResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-blackbook-model-Unsubscribe"}},"paging":{"$ref":"#/components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingResponse"}},"required":["items","paging"]}},"components/schemas/github.com-mailgun-blackbook-api-UnsubscribesList":{"id":"components/schemas/github.com-mailgun-blackbook-api-UnsubscribesList","kind":"json-schema","title":"github.com-mailgun-blackbook-api-UnsubscribesList","data":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-blackbook-model-Unsubscribe"}}},"components/schemas/POST-v3-domainID-unsubscribes-application-form-data-RequestBody":{"id":"components/schemas/POST-v3-domainID-unsubscribes-application-form-data-RequestBody","kind":"json-schema","title":"POST-v3-domainID-unsubscribes-application-form-data-RequestBody","data":{"type":"object","properties":{"address":{"type":"string","description":"Valid email address"},"tags":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag to unsubscribe from, use * to unsubscribe an address from all domain’s correspondence (optional, default: *)"},"children":[]}]}]}]},"created_at":{"type":"string","description":"Timestamp of an unsubscribe event in RFC2822 format (optional, default: current time)"}},"required":["address"]}},"components/schemas/github.com-mailgun-blackbook-model-Complaint":{"id":"components/schemas/github.com-mailgun-blackbook-model-Complaint","kind":"json-schema","title":"github.com-mailgun-blackbook-model-Complaint","data":{"type":"object","properties":{"address":{"type":"string","description":"Email address for the original recipient"},"created_at":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-mime-RFC822Time"}],"description":"Timestamp for when the Complaint event was received in RFC822 format"}},"required":["address","created_at"]}},"components/schemas/github.com-mailgun-blackbook-api-getComplaintsPaginationResponse":{"id":"components/schemas/github.com-mailgun-blackbook-api-getComplaintsPaginationResponse","kind":"json-schema","title":"github.com-mailgun-blackbook-api-getComplaintsPaginationResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-blackbook-model-Complaint"}},"paging":{"$ref":"#/components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingResponse"}},"required":["items","paging"]}},"components/schemas/github.com-mailgun-blackbook-api-ComplaintsList":{"id":"components/schemas/github.com-mailgun-blackbook-api-ComplaintsList","kind":"json-schema","title":"github.com-mailgun-blackbook-api-ComplaintsList","data":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-blackbook-model-Complaint"}}},"components/schemas/POST-v3-domainID-complaints-application-form-data-RequestBody":{"id":"components/schemas/POST-v3-domainID-complaints-application-form-data-RequestBody","kind":"json-schema","title":"POST-v3-domainID-complaints-application-form-data-RequestBody","data":{"type":"object","properties":{"address":{"type":"string","description":"Valid email address"},"created_at":{"type":"string","description":"Timestamp of a complaint event in RFC2822 format (optional, default: current time)"}},"required":["address"]}},"components/schemas/github.com-mailgun-blackbook-model-Whitelist":{"id":"components/schemas/github.com-mailgun-blackbook-model-Whitelist","kind":"json-schema","title":"github.com-mailgun-blackbook-model-Whitelist","data":{"type":"object","properties":{"type":{"type":"string","description":"Type of allowlist"},"value":{"type":"string","description":"Domain or address allowlisted"},"createdAt":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-mime-RFC822Time"}],"description":"Timestamp for when the entry was created in RFC822 format"},"reason":{"type":"string","description":"User-provided reason for allowlisting"}},"required":["type","value","createdAt","reason"]}},"components/schemas/github.com-mailgun-blackbook-api-getWhitelistPaginationResponse":{"id":"components/schemas/github.com-mailgun-blackbook-api-getWhitelistPaginationResponse","kind":"json-schema","title":"github.com-mailgun-blackbook-api-getWhitelistPaginationResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-blackbook-model-Whitelist"}},"paging":{"$ref":"#/components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingResponse"}},"required":["items","paging"]}},"components/schemas/github.com-mailgun-blackbook-api-insertWhitelistRecordResponse":{"id":"components/schemas/github.com-mailgun-blackbook-api-insertWhitelistRecordResponse","kind":"json-schema","title":"github.com-mailgun-blackbook-api-insertWhitelistRecordResponse","data":{"type":"object","properties":{"message":{"type":"string","description":"Response message"},"type":{"type":"string","description":"Type of allowlist"},"value":{"type":"string","description":"Domain or address"}},"required":["message","type","value"]}},"components/schemas/POST-v3-domainID-whitelists-application-form-data-RequestBody":{"id":"components/schemas/POST-v3-domainID-whitelists-application-form-data-RequestBody","kind":"json-schema","title":"POST-v3-domainID-whitelists-application-form-data-RequestBody","data":{"type":"object","properties":{"address":{"type":"string","description":"Valid email address if you would like to allowlist email address (prior over 'domain' parameter)"},"domain":{"type":"string","description":"Valid domain name if you would like allowlist entire domain name"}},"required":["address"]}},"components/schemas/github.com-mailgun-blackbook-api-deleteWhitelistRecordResponse":{"id":"components/schemas/github.com-mailgun-blackbook-api-deleteWhitelistRecordResponse","kind":"json-schema","title":"github.com-mailgun-blackbook-api-deleteWhitelistRecordResponse","data":{"type":"object","properties":{"message":{"type":"string","description":"Response message"},"value":{"type":"string","description":"Domain or address"}},"required":["message","value"]}},"components/schemas/RouteResponse":{"id":"components/schemas/RouteResponse","kind":"json-schema","title":"RouteResponse","data":{"type":"object","title":"RouteResponse","properties":{"id":{"type":"string","description":"Unique identifier of the route"},"priority":{"type":"integer","description":"Smaller number indicates higher priority. Higher priority routes are handled first."},"description":{"type":"string","description":"An arbitrary string."},"expression":{"type":"string","description":"The filtering rule."},"actions":{"type":"array","items":{"type":"string"},"description":"These actions are executed when the expression evaluates to True."},"created_at":{"type":"string","description":"Timestamp indicating when the route was created in RFC1123 format"}},"examples":[{"id":"4f3bad2335335426750048c6","priority":0,"description":"Sample route","expression":"match_recipient(\".*@samples.mailgun.org\")","actions":["forward(\"http://myhost.com/messages/\")","stop()"],"created_at":"Wed, 15 Feb 2012 13:03:31 GMT"}]}},"components/schemas/ListMemberRequest":{"id":"components/schemas/ListMemberRequest","kind":"json-schema","title":"Mailing list member","data":{"type":"object","title":"Mailing list member","properties":{"name":{"type":"string"},"address":{"type":"string"},"subscribed":{"type":"boolean"},"vars":{"type":"object"}},"examples":[{"address":"dev@mailgun.net","name":"Super Developer","subscribed":true,"vars":{"department":"Support","rank":"Monarch","memo":"Give them a raise"}}]}},"components/schemas/MailingListResponse":{"id":"components/schemas/MailingListResponse","kind":"json-schema","title":"The mailing list response","data":{"type":"object","title":"The mailing list response","properties":{"address":{"type":"string","description":"The email address of the mailing list"},"name":{"type":"string","description":"The name of the mailing list"},"description":{"type":"string","description":"A description of the mailing list"},"access_level":{"type":"string","description":"List access level, one of: readonly, members, everyone"},"reply_preference":{"type":"string","description":"Set where replies should go: list or sender"},"created_at":{"type":"string","description":"Timestamp indicating the mailing list creation time in RFC 5322 format"},"members_count":{"type":"integer","description":"The number of members on the mailing list"}},"examples":[{"address":"developers@mailgun.net","name":"Developers","description":"Describe the mailing list","access_level":"readonly","reply_preference":"list","created_at":"Tue, 09 Aug 2011 20:50:27 -0000","members_count":2}]}},"components/schemas/ListMemberResponse":{"id":"components/schemas/ListMemberResponse","kind":"json-schema","title":"ListMemberResponse","data":{"type":"object","title":"ListMemberResponse","properties":{"address":{"type":"string","description":"The email address of the mailing list"},"name":{"type":"string","description":"The name of the mailing list"},"vars":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A JSON-encoded dictionary string with arbitrary parameters, e.g. {\"gender\":\"female\",\"age\":27}"},"children":[]}]}]}]},"subscribed":{"type":"boolean","description":"Whether the member is subscribed or not"}},"examples":[{"address":"alice@example.com","name":"Alice","vars":{"gender":"female","age":27},"subscribed":true}]}},"components/schemas/PaginateMailingListResponse":{"id":"components/schemas/PaginateMailingListResponse","kind":"json-schema","title":"PaginateMailingListResponse","data":{"type":"object","title":"PaginateMailingListResponse","properties":{"paging":{"type":"object","properties":{"first":{"type":"string","description":"URL to the first page"},"next":{"type":"string","description":"URL to the next page"},"previous":{"type":"string","description":"URL to the previous page"},"last":{"type":"string","description":"URL to the last page"}}},"items":{"type":"array","items":{"$ref":"#/components/schemas/MailingListResponse"}}},"examples":[{"paging":{"first":"https://url_to_next_page","last":"https://url_to_last_page","next":"https://url_to_next_page","previous":"https://url_to_previous_page"},"items":[{"access_level":"everyone","address":"dev@samples.mailgun.org","created_at":"Tue, 06 Mar 2012 05:44:45 GMT","description":"Mailgun developers list","members_count":1,"name":""},{"access_level":"readonly","address":"bar@example.com","created_at":"Wed, 06 Mar 2013 11:39:51 GMT","description":"","members_count":2,"name":""}]}]}},"components/schemas/PaginateListMemberResponse":{"id":"components/schemas/PaginateListMemberResponse","kind":"json-schema","title":"PaginateListMemberResponse","data":{"type":"object","title":"PaginateListMemberResponse","properties":{"paging":{"type":"object","properties":{"first":{"type":"string"},"next":{"type":"string"},"last":{"type":"string"},"previous":{"type":"string"}}},"items":{"type":"array","items":{"$ref":"#/components/schemas/ListMemberResponse"}}},"examples":[{"items":[{"vars":{"age":26},"name":"Foo Bar","subscribed":false,"address":"bar@example.com"}],"paging":{"first":"https://url_to_first_page","last":"https://url_to_last_page","next":"http://url_to_next_page","previous":"http://url_to_previous_page"}}]}},"components/schemas/github.com-mailgun-temple-model-Version":{"id":"components/schemas/github.com-mailgun-temple-model-Version","kind":"json-schema","title":"github.com-mailgun-temple-model-Version","data":{"type":"object","properties":{"tag":{"type":"string","description":"Tag of the version. Must be unique to the template"},"template":{"type":"string","description":"Template content"},"engine":{"type":"string","description":"Rendering engine"},"mjml":{"type":"string","description":"Template source"},"createdAt":{"type":"string","description":"Creation date in RFC822 format","readOnly":true},"comment":{"type":"string","description":"Comment related to the version"},"active":{"type":"boolean","description":"If this flag is true"},"id":{"type":"string","description":"Template ID","readOnly":true},"headers":{"type":"object","additionalProperties":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key value JSON object of headers to be stored with the template. Where key is the header name and value is the header value. The header names "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"From"},"children":[]}]}]}]}},"required":["tag","engine","mjml","createdAt","comment","active","id"]}},"components/schemas/github.com-mailgun-temple-model-Template":{"id":"components/schemas/github.com-mailgun-temple-model-Template","kind":"json-schema","title":"github.com-mailgun-temple-model-Template","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the template"},"description":{"type":"string","description":"Description of the template"},"createdAt":{"type":"string","description":"Creation date in RFC822 format","readOnly":true},"createdBy":{"type":"string","description":"Indicate who created the template"},"id":{"type":"string","description":"Template ID","readOnly":true},"domain":{"type":"string","description":"Domain of the template"},"version":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-temple-model-Version"},{"type":"null"}],"description":"Active version information","readOnly":true},"versions":{"type":["array","null"],"items":{"$ref":"#/components/schemas/github.com-mailgun-temple-model-Version"},"description":"List of template's versions","readOnly":true}},"required":["name"]}},"components/schemas/github.com-mailgun-temple-httpapi-createTemplateOrVersionResponse":{"id":"components/schemas/github.com-mailgun-temple-httpapi-createTemplateOrVersionResponse","kind":"json-schema","title":"github.com-mailgun-temple-httpapi-createTemplateOrVersionResponse","data":{"type":"object","properties":{"message":{"type":"string","description":"Response message"},"template":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-temple-model-Template"},{"type":"null"}],"description":"Template details"}},"required":["message","template"]}},"components/schemas/POST-v3-domain_name-templates-multipart-form-data-RequestBody":{"id":"components/schemas/POST-v3-domain_name-templates-multipart-form-data-RequestBody","kind":"json-schema","title":"POST-v3-domain_name-templates-multipart-form-data-RequestBody","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the template being stored. Supports utf-8 characters and name will be down cased."},"description":{"type":"string","description":"Description of the template being stored"},"createdBy":{"type":"string","description":"Optional metadata field api user can indicate who created the template."},"template":{"type":"string","description":"Content of the template."},"tag":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initial tag of the created version. If the template parameter is provided and the tag is missing, the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used."},"children":[]}]}]}]},"comment":{"type":"string","description":"Version comment. This is valid only if a new version is being created. (template parameter is provided.)"},"headers":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key value JSON object of headers to be stored with the template. Where key is the header name and value is the header value. The header names "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"From"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Reply-To"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are the only ones currently supported.  These headers will be inserted into the MIME at the time we attempt delivery."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Headers set at the message level will override headers set on the template. e.g. Setting the From header at the time of sending will override the From header saved on the template. Additionally, headers generated by templates are not reflected on the accepted event as they are not prepended to the message until the message is prepped for delivery. if a From header is not provided either in the message or template, we will default to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"postmaster@your-sending-domain.tld"},"children":[]}]}]}]}},"required":["name"]}},"components/schemas/POST-v3-domain_name-templates-template_name-versions-multipart-form-data-RequestBody":{"id":"components/schemas/POST-v3-domain_name-templates-template_name-versions-multipart-form-data-RequestBody","kind":"json-schema","title":"POST-v3-domain_name-templates-template_name-versions-multipart-form-data-RequestBody","data":{"type":"object","properties":{"template":{"type":"string","description":"Content of the template."},"tag":{"type":"string","description":"Tag of the version that is being created. Must be unique to the template."},"comment":{"type":"string","description":"Comment related to the version that is being created."},"active":{"type":"string","description":"If this flag is set to yes, this version becomes active"},"headers":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key value JSON object of headers to be stored with the template. Where key is the header name and value is the header value. The header names "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"From"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Reply-To"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are the only ones currently supported.  These headers will be inserted into the MIME at the time we attempt delivery."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Headers set at the message level will override headers set on the template. e.g. Setting the From header at the time of sending will override the From header saved on the template. Additionally, headers generated by templates are not reflected on the accepted event as they are not prepended to the message until the message is prepped for delivery. if a From header is not provided either in the message or template, we will default to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"postmaster@your-sending-domain.tld"},"children":[]}]}]}]}},"required":["template","tag"]}},"components/schemas/github.com-mailgun-temple-httpapi-getTemplateOrVersionResponse":{"id":"components/schemas/github.com-mailgun-temple-httpapi-getTemplateOrVersionResponse","kind":"json-schema","title":"github.com-mailgun-temple-httpapi-getTemplateOrVersionResponse","data":{"type":"object","properties":{"template":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-temple-model-Template"},{"type":"null"}],"description":"Template details"}},"required":["template"]}},"components/schemas/github.com-mailgun-temple-httpapi-getVersionsPageResponse":{"id":"components/schemas/github.com-mailgun-temple-httpapi-getVersionsPageResponse","kind":"json-schema","title":"github.com-mailgun-temple-httpapi-getVersionsPageResponse","data":{"type":"object","properties":{"template":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-temple-model-Template"},{"type":"null"}],"description":"Template details"},"paging":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingResponse"}],"description":"Pagination details"}},"required":["template","paging"]}},"components/schemas/github.com-mailgun-temple-httpapi-getPageResponse":{"id":"components/schemas/github.com-mailgun-temple-httpapi-getPageResponse","kind":"json-schema","title":"github.com-mailgun-temple-httpapi-getPageResponse","data":{"type":"object","properties":{"items":{"type":["array","null"],"items":{"$ref":"#/components/schemas/github.com-mailgun-temple-model-Template"},"description":"List of items"},"paging":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingResponse"}],"description":"Pagination details"}},"required":["items","paging"]}},"components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyRequest":{"id":"components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyRequest","kind":"json-schema","title":"github.com-mailgun-temple-httpapi-TemplateCopyRequest","data":{"type":"object","properties":{"account_id":{"type":"string","description":"Target account ID to copy the template to"},"name":{"type":"string","description":"Name of the new template in the target account"},"domain":{"type":"string","description":"Domain of the new template in the target account"}},"required":["account_id","name"]}},"components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyResponse":{"id":"components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyResponse","kind":"json-schema","title":"github.com-mailgun-temple-httpapi-TemplateCopyResponse","data":{"type":"object","properties":{"message":{"type":"string","description":"Response message"},"failed_copies":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyRequest"},"description":"Failed copy requests"},"error":{"type":"string","description":"A error that occurred during copying"}},"required":["message","failed_copies"]}},"components/schemas/github.com-mailgun-scaffold-httpapi-ResponseWithStatus":{"id":"components/schemas/github.com-mailgun-scaffold-httpapi-ResponseWithStatus","kind":"json-schema","title":"github.com-mailgun-scaffold-httpapi-ResponseWithStatus","data":{"type":"object","properties":{"Response":{"type":"object"},"Status":{"type":"integer","format":"int32"}},"required":["Response","Status"]}},"components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyParams":{"id":"components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyParams","kind":"json-schema","title":"github.com-mailgun-temple-httpapi-TemplateCopyParams","data":{"type":"object","properties":{"requests":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-temple-httpapi-TemplateCopyRequest"},"description":"List of copy requests"},"source_versions":{"type":"array","items":{"type":"string"},"description":"Versions to copy or all versions if empty."}},"required":["requests"]}},"components/schemas/github.com-mailgun-temple-httpapi-versionCopyResponse":{"id":"components/schemas/github.com-mailgun-temple-httpapi-versionCopyResponse","kind":"json-schema","title":"github.com-mailgun-temple-httpapi-versionCopyResponse","data":{"type":"object","properties":{"message":{"type":"string","description":"Response message"},"version":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-temple-model-Version"},{"type":"null"}],"description":"Created version details"},"template":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-temple-model-Version"},{"type":"null"}],"description":"Deprecated: Use 'version' field","deprecated":true}},"required":["message","version","template"]}},"components/schemas/github.com-mailgun-temple-httpapi-versionUpdate":{"id":"components/schemas/github.com-mailgun-temple-httpapi-versionUpdate","kind":"json-schema","title":"github.com-mailgun-temple-httpapi-versionUpdate","data":{"type":"object","properties":{"tag":{"type":"string","description":"Tag of the version. Must be unique to the template"}},"required":["tag"]}},"components/schemas/github.com-mailgun-temple-httpapi-templateUpdate":{"id":"components/schemas/github.com-mailgun-temple-httpapi-templateUpdate","kind":"json-schema","title":"github.com-mailgun-temple-httpapi-templateUpdate","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the template"},"version":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-temple-httpapi-versionUpdate"},{"type":"null"}],"description":"Template version details"}},"required":["name"]}},"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse":{"id":"components/schemas/github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","kind":"json-schema","title":"github.com-mailgun-temple-httpapi-updateOrDeleteTemplateOrVersionResponse","data":{"type":"object","properties":{"message":{"type":"string","description":"Response message"},"template":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-temple-httpapi-templateUpdate"}],"description":"Template change details"}},"required":["message","template"]}},"components/schemas/PUT-v3-domain_name-templates-template_name-versions-version_name-multipart-form-data-RequestBody":{"id":"components/schemas/PUT-v3-domain_name-templates-template_name-versions-version_name-multipart-form-data-RequestBody","kind":"json-schema","title":"PUT-v3-domain_name-templates-template_name-versions-version_name-multipart-form-data-RequestBody","data":{"type":"object","properties":{"template":{"type":"string","description":"Content of the template."},"comment":{"type":"string","description":"Comment related to the version that is being created."},"active":{"type":"string","description":"If this flag is set to yes, this version becomes active"},"headers":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key value JSON object of headers to be stored with the template. Where key is the header name and value is the header value. The header names "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"From"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Reply-To"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are the only ones currently supported.  These headers will be inserted into the MIME at the time we attempt delivery."},"children":[]}]}]}]}}}},"components/schemas/PUT-v3-domain_name-templates-template_name-multipart-form-data-RequestBody":{"id":"components/schemas/PUT-v3-domain_name-templates-template_name-multipart-form-data-RequestBody","kind":"json-schema","title":"PUT-v3-domain_name-templates-template_name-multipart-form-data-RequestBody","data":{"type":"object","properties":{"description":{"type":"string","description":"Update description of the template being updated."}},"required":["description"]}},"components/schemas/POST-v4-templates-multipart-form-data-RequestBody":{"id":"components/schemas/POST-v4-templates-multipart-form-data-RequestBody","kind":"json-schema","title":"POST-v4-templates-multipart-form-data-RequestBody","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the template being stored. Supports utf-8 characters and name will be down cased."},"description":{"type":"string","description":"Description of the template being stored"},"createdBy":{"type":"string","description":"Optional metadata field api user can indicate who created the template."},"template":{"type":"string","description":"Content of the template."},"tag":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initial tag of the created version. If the template parameter is provided and the tag is missing, the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used."},"children":[]}]}]}]},"comment":{"type":"string","description":"Version comment. This is valid only if a new version is being created. (template parameter is provided.)"},"headers":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key value JSON object of headers to be stored with the template. Where key is the header name and value is the header value. The header names "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"From"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Reply-To"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are the only ones currently supported."},"children":[]}]}]}]}},"required":["name"]}},"components/schemas/POST-v4-templates-template_name-versions-multipart-form-data-RequestBody":{"id":"components/schemas/POST-v4-templates-template_name-versions-multipart-form-data-RequestBody","kind":"json-schema","title":"POST-v4-templates-template_name-versions-multipart-form-data-RequestBody","data":{"type":"object","properties":{"template":{"type":"string","description":"Content of the template."},"tag":{"type":"string","description":"Tag of the version that is being created. Must be unique to the template."},"comment":{"type":"string","description":"Comment related to the version that is being created."},"active":{"type":"string","description":"If this flag is set to yes, this version becomes active"},"headers":{"type":"string","description":"Key value JSON object of headers to be stored with the template."}},"required":["template","tag"]}},"components/schemas/PUT-v4-templates-template_name-versions-version_name-multipart-form-data-RequestBody":{"id":"components/schemas/PUT-v4-templates-template_name-versions-version_name-multipart-form-data-RequestBody","kind":"json-schema","title":"PUT-v4-templates-template_name-versions-version_name-multipart-form-data-RequestBody","data":{"type":"object","properties":{"template":{"type":"string","description":"Content of the template."},"comment":{"type":"string","description":"Comment related to the version."},"active":{"type":"string","description":"If this flag is set to yes, this version becomes active"},"headers":{"type":"string","description":"Key value JSON object of headers to be stored with the template."}}}},"components/schemas/PUT-v4-templates-template_name-multipart-form-data-RequestBody":{"id":"components/schemas/PUT-v4-templates-template_name-multipart-form-data-RequestBody","kind":"json-schema","title":"PUT-v4-templates-template_name-multipart-form-data-RequestBody","data":{"type":"object","properties":{"description":{"type":"string","description":"Update description of the template being updated."}},"required":["description"]}},"components/schemas/github.com-mailgun-accounts-api-CustomMessageLimitResponse":{"id":"components/schemas/github.com-mailgun-accounts-api-CustomMessageLimitResponse","kind":"json-schema","title":"github.com-mailgun-accounts-api-CustomMessageLimitResponse","data":{"type":"object","properties":{"limit":{"type":"number","description":"The custom limit set for the account"},"current":{"type":"number","description":"The number of messages already sent"},"period":{"type":"string","description":"The timeframe for which the limit applies - m for months, d for days, h for hours"}}}},"components/schemas/github.com-mailgun-accounts-api-SubaccountStatus":{"id":"components/schemas/github.com-mailgun-accounts-api-SubaccountStatus","kind":"json-schema","title":"github.com-mailgun-accounts-api-SubaccountStatus","data":{"type":"string","enum":["disabled","open","closed"],"description":"The status of the subaccount","x-enumDescriptions":{"disabled":"Account is disabled","open":"Account is open","closed":"Account is closed"}}},"components/schemas/github.com-mailgun-accounts-api-Subaccount":{"id":"components/schemas/github.com-mailgun-accounts-api-Subaccount","kind":"json-schema","title":"github.com-mailgun-accounts-api-Subaccount","data":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the subaccount"},"name":{"type":"string","description":"The name of the subaccount"},"created_at":{"type":"string","description":"The date when the account was created serialized as RFC 1123 (HTTP-date) string in GMT (UTC)","example":"Wed, 28 May 2025 20:03:05 GMT","pattern":"^[A-Z][a-z]{2}, [0-9]{2} [A-Z][a-z]{2} [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$"},"updated_at":{"type":"string","description":"The date when the account was last updated serialized as RFC 1123 (HTTP-date) string in GMT (UTC)","example":"Wed, 28 May 2025 20:03:05 GMT","pattern":"^[A-Z][a-z]{2}, [0-9]{2} [A-Z][a-z]{2} [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$"},"status":{"$ref":"#/components/schemas/github.com-mailgun-accounts-api-SubaccountStatus"},"features":{"$ref":"#/components/schemas/github.com-mailgun-accounts-api-FeaturesResponse"}}}},"components/schemas/github.com-mailgun-accounts-api-SubaccountResponse":{"id":"components/schemas/github.com-mailgun-accounts-api-SubaccountResponse","kind":"json-schema","title":"github.com-mailgun-accounts-api-SubaccountResponse","data":{"type":"object","properties":{"subaccount":{"$ref":"#/components/schemas/github.com-mailgun-accounts-api-Subaccount"}}}},"components/schemas/github.com-mailgun-accounts-api-SubaccountListResponse":{"id":"components/schemas/github.com-mailgun-accounts-api-SubaccountListResponse","kind":"json-schema","title":"github.com-mailgun-accounts-api-SubaccountListResponse","data":{"type":"object","properties":{"subaccounts":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-accounts-api-Subaccount"}},"total":{"type":"integer","description":"The total number of subaccounts"}}}},"components/schemas/github.com-mailgun-accounts-api-HTTPSigningKey":{"id":"components/schemas/github.com-mailgun-accounts-api-HTTPSigningKey","kind":"json-schema","title":"github.com-mailgun-accounts-api-HTTPSigningKey","data":{"type":"object","properties":{"message":{"type":"string","description":"Success message"},"http_signing_key":{"type":"string","description":"Decoded webhook signing key"}}}},"components/schemas/github.com-mailgun-accounts-api-RecipientResponse":{"id":"components/schemas/github.com-mailgun-accounts-api-RecipientResponse","kind":"json-schema","title":"github.com-mailgun-accounts-api-RecipientResponse","data":{"type":"object","properties":{"email":{"type":"string","description":"Email address of sandbox domain recipient"},"activated":{"type":"boolean","description":"Activated/verified status of the recipient"}}}},"components/schemas/github.com-mailgun-accounts-api-FeaturesResponse":{"id":"components/schemas/github.com-mailgun-accounts-api-FeaturesResponse","kind":"json-schema","title":"github.com-mailgun-accounts-api-FeaturesResponse","data":{"type":"object","additionalProperties":true}},"components/schemas/github.com-mailgun-accounts-api-GenericSuccess":{"id":"components/schemas/github.com-mailgun-accounts-api-GenericSuccess","kind":"json-schema","title":"github.com-mailgun-accounts-api-GenericSuccess","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates success of request"}}}},"components/schemas/github.com-mailgun-accounts-api-GenericMessage":{"id":"components/schemas/github.com-mailgun-accounts-api-GenericMessage","kind":"json-schema","title":"github.com-mailgun-accounts-api-GenericMessage","data":{"type":"object","properties":{"message":{"type":"string","description":"Response message"}}}},"components/schemas/github.com-mailgun-cerberus-keys-Kind":{"id":"components/schemas/github.com-mailgun-cerberus-keys-Kind","kind":"json-schema","title":"github.com-mailgun-cerberus-keys-Kind","data":{"type":"string","enum":["domain","user","web"],"description":"Kind","x-enumDescriptions":{"domain":"Domain-specific API key for keys with 'sending' role","user":"API key tied to a user role for RBAC limitations","web":"Web session API key generated for user login sessions"}}},"components/schemas/github.com-mailgun-cerberus-keys-Role":{"id":"components/schemas/github.com-mailgun-cerberus-keys-Role","kind":"json-schema","title":"github.com-mailgun-cerberus-keys-Role","data":{"type":"string","enum":["admin","basic","sending","developer"],"description":"Role","x-enumDescriptions":{"admin":"Provides admin-level permissions on an API key","basic":"Provides basic aka analyst-level permissions on an API key","sending":"Provides domain-scoped permissions on an API key for use only with 'domain' kind key","developer":"Provides developer-level permissions on an API key"}}},"components/schemas/github.com-mailgun-cerberus-keys-KeyInfoResp":{"id":"components/schemas/github.com-mailgun-cerberus-keys-KeyInfoResp","kind":"json-schema","title":"github.com-mailgun-cerberus-keys-KeyInfoResp","data":{"type":"object","properties":{"id":{"type":"string","description":"The ID for the key"},"description":{"type":"string","description":"The description provided for the key upon its creation"},"kind":{"type":"string","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-cerberus-keys-Kind"}],"description":"The type of the key which determines how it can be used"},"role":{"type":"string","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-cerberus-keys-Role"}],"description":"The role of the key which determines its scope in CRUD operations that have role-based access control"},"created_at":{"type":"string","description":"When the key was created in ISO 8601 date-time format without timezone offset (UTC time)","example":"2026-01-23T10:16:00","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"When the key was last updated in ISO 8601 date-time format without timezone offset (UTC time)","example":"2026-01-23T10:16:00","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$"},"expires_at":{"type":"string","description":"When the key will expire in ISO 8601 date-time format without timezone offset (UTC time)","example":"2026-01-23T10:16:00","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$"},"disabled_reason":{"type":"string","description":"The reason for the key's disablement if applicable"},"is_disabled":{"type":"boolean","description":"Whether or not the key is disabled from use"},"domain_name":{"oneOf":[{"type":"string","description":"The sending domain associated with the key required for 'domain' kind keys"},{"type":"null","description":"No sending domain associated with the key"}]},"requestor":{"oneOf":[{"type":"string","description":"An email address associated with the key"},{"type":"null","description":"No email address associated with the key"}]},"user_name":{"oneOf":[{"type":"string","description":"The API key user's name"},{"type":"null","description":"No API key user name associated with the key"}]}},"required":["id","description","kind","role","created_at","updated_at","is_disabled","domain_name","requestor","user_name"]}},"components/schemas/github.com-mailgun-cerberus-keys-KeysResp":{"id":"components/schemas/github.com-mailgun-cerberus-keys-KeysResp","kind":"json-schema","title":"github.com-mailgun-cerberus-keys-KeysResp","data":{"type":"object","properties":{"total_count":{"type":"integer","format":"int32","description":"The number of keys returned in 'items'"},"items":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-cerberus-keys-KeyInfoResp"}}},"required":["total_count","items"]}},"components/schemas/github.com-mailgun-cerberus-keys-KeyInfoSecretResp":{"id":"components/schemas/github.com-mailgun-cerberus-keys-KeyInfoSecretResp","kind":"json-schema","title":"github.com-mailgun-cerberus-keys-KeyInfoSecretResp","data":{"type":"object","properties":{"id":{"type":"string","description":"The ID for the key"},"description":{"type":"string","description":"The description provided for the key upon its creation"},"kind":{"type":"string","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-cerberus-keys-Kind"}],"description":"The type of the key which determines how it can be used"},"role":{"type":"string","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-cerberus-keys-Role"}],"description":"The role of the key which determines its scope in CRUD operations that have role-based access control"},"created_at":{"type":"string","description":"When the key was created in ISO 8601 date-time format without timezone offset (UTC time)","example":"2026-01-23T10:16:00","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$"},"updated_at":{"type":"string","description":"When the key was last updated in ISO 8601 date-time format without timezone offset (UTC time)","example":"2026-01-23T10:16:00","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$"},"expires_at":{"type":"string","description":"When the key will expire in ISO 8601 date-time format without timezone offset (UTC time)","example":"2026-01-23T10:16:00","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$"},"disabled_reason":{"type":"string","description":"The reason for the key's disablement if applicable"},"is_disabled":{"type":"boolean","description":"Whether or not the key is disabled from use"},"domain_name":{"oneOf":[{"type":"string","description":"The sending domain associated with the key required for 'domain' kind keys"},{"type":"null","description":"No sending domain associated with the key"}]},"requestor":{"oneOf":[{"type":"string","description":"An email address associated with the key"},{"type":"null","description":"No email address associated with the key"}]},"user_name":{"oneOf":[{"type":"string","description":"The API key user's name"},{"type":"null","description":"No API key user name associated with the key"}]},"secret":{"type":"string","description":"The full API key secret in plain text returned only once upon key creation","format":"password"}},"required":["id","description","kind","role","created_at","updated_at","is_disabled","domain_name","requestor","user_name","secret"]}},"components/schemas/github.com-mailgun-cerberus-keys-CreateKeyResp":{"id":"components/schemas/github.com-mailgun-cerberus-keys-CreateKeyResp","kind":"json-schema","title":"github.com-mailgun-cerberus-keys-CreateKeyResp","data":{"type":"object","properties":{"message":{"type":"string","description":"Response message"},"key":{"$ref":"#/components/schemas/github.com-mailgun-cerberus-keys-KeyInfoSecretResp"}},"required":["message","key"]}},"components/schemas/POST-v1-keys-multipart-form-data-RequestBody":{"id":"components/schemas/POST-v1-keys-multipart-form-data-RequestBody","kind":"json-schema","title":"POST-v1-keys-multipart-form-data-RequestBody","data":{"type":"object","properties":{"domain_name":{"type":"string","description":"Web domain to associate with the key, for keys of 'domain' kind"},"kind":{"type":"string","enum":["domain","user","web"],"description":"Type of API key ('domain', 'user', or 'web'). Defaults to 'user' if not provided. Note: web keys are not subject to IP allowlisting and have a default/maximum validity period of 1 day.","x-enumDescriptions":{"domain":"Create API key of type 'domain'","user":"Create API key of type 'user'","web":"Create API key of type 'web'"}},"description":{"type":"string","description":"Key description"},"expiration":{"type":"integer","description":"Key lifetime in seconds, must be greater than 0 if set"},"role":{"type":"string","enum":["admin","basic","sending","developer"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key role ('admin', 'basic' [use in place of analyst], 'sending' [use with keys of domain kind], or 'developer')"},"children":[]}]}]}],"x-enumDescriptions":{"admin":"Provides admin-level permissions on an API key","basic":"Provides basic aka analyst-level permissions on an API key","sending":"Provides domain-scoped permissions on an API key for use only with 'domain' kind key","developer":"Provides developer-level permissions on an API key"}},"user_id":{"type":"string","description":"API Key user's string user ID; should be provided for all keys of 'web' kind"},"user_name":{"type":"string","description":"API Key user's name"},"email":{"type":"string","description":"API Key user's email address; should be provided for all keys of 'web' kind"}},"required":["role"]}},"components/schemas/github.com-mailgun-cerberus-keys-PublicKeyResp":{"id":"components/schemas/github.com-mailgun-cerberus-keys-PublicKeyResp","kind":"json-schema","title":"github.com-mailgun-cerberus-keys-PublicKeyResp","data":{"type":"object","properties":{"key":{"type":"string","description":"The account public key"},"message":{"type":"string","description":"Response message"}},"required":["key","message"]}},"components/schemas/github.com-mailgun-cerberus-credentials-CredentialMetadata":{"id":"components/schemas/github.com-mailgun-cerberus-credentials-CredentialMetadata","kind":"json-schema","title":"github.com-mailgun-cerberus-credentials-CredentialMetadata","data":{"type":"object","properties":{"mailbox":{"type":"string","description":"The email address-style username associated with this credential"},"login":{"type":"string","description":"The email address-style username associated with this credential"},"created_at":{"type":"string","description":"When the credential was created in RFC 2822 format with numeric timezone offset (UTC time)","example":"Fri, 23 Jan 2026 10:16:00 +0000","pattern":"^[A-Z][a-z]{2}, [0-9]{2} [A-Z][a-z]{2} [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} [+-][0-9]{4}$"},"size_bytes":{"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["mailbox","login","created_at","size_bytes"]}},"components/schemas/github.com-mailgun-cerberus-credentials-ListCredsResp":{"id":"components/schemas/github.com-mailgun-cerberus-credentials-ListCredsResp","kind":"json-schema","title":"github.com-mailgun-cerberus-credentials-ListCredsResp","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-cerberus-credentials-CredentialMetadata"}},"total_count":{"type":"integer","format":"int32","description":"The number of credentials described in 'items'"}},"required":["items","total_count"]}},"components/schemas/github.com-mailgun-cerberus-credentials-CreateCredsResp":{"id":"components/schemas/github.com-mailgun-cerberus-credentials-CreateCredsResp","kind":"json-schema","title":"github.com-mailgun-cerberus-credentials-CreateCredsResp","data":{"type":"object","properties":{"message":{"type":"string","description":"Response message"},"note":{"type":"string","description":"Note to store password (when generated by Mailgun)"},"credentials":{"type":"object","additionalProperties":{"type":"string"},"description":"Credential username/password values (when generated by Mailgun)"}},"required":["message"]}},"components/schemas/POST-v3-domains-domain_name-credentials-multipart-form-data-RequestBody":{"id":"components/schemas/POST-v3-domains-domain_name-credentials-multipart-form-data-RequestBody","kind":"json-schema","title":"POST-v3-domains-domain_name-credentials-multipart-form-data-RequestBody","data":{"type":"object","properties":{"login":{"type":"string","description":"Email address of SMTP credential user; accepts multiple values"},"mailbox":{"type":"string","description":"Email address of SMTP credential user, may be used in place of 'login'; accepts multiple values"},"system":{"type":"boolean","description":"Identify if these are system account credentials, defaults to false"},"password":{"type":"string","description":"Supply desired password(s) for the new credentials if preferred over generated ones; accepts multiple values"}},"required":["login"]}},"components/schemas/PUT-v3-domains-domain_name-credentials-spec-multipart-form-data-RequestBody":{"id":"components/schemas/PUT-v3-domains-domain_name-credentials-spec-multipart-form-data-RequestBody","kind":"json-schema","title":"PUT-v3-domains-domain_name-credentials-spec-multipart-form-data-RequestBody","data":{"type":"object","properties":{"password":{"type":"string","description":"Supply desired password for the credentials to update if preferred over a generated one"}}}},"components/schemas/github.com-mailgun-cerberus-credentials-DeleteDomainCredsResp":{"id":"components/schemas/github.com-mailgun-cerberus-credentials-DeleteDomainCredsResp","kind":"json-schema","title":"github.com-mailgun-cerberus-credentials-DeleteDomainCredsResp","data":{"type":"object","properties":{"message":{"type":"string","description":"Response message"},"count":{"type":"integer","format":"int32","description":"The number of credentials deleted"}},"required":["message","count"]}},"components/schemas/github.com-mailgun-cerberus-credentials-DeleteCredsResp":{"id":"components/schemas/github.com-mailgun-cerberus-credentials-DeleteCredsResp","kind":"json-schema","title":"github.com-mailgun-cerberus-credentials-DeleteCredsResp","data":{"type":"object","properties":{"message":{"type":"string","description":"Response message"},"spec":{"type":"string","description":"The mailbox username associated with the deleted credentials"}},"required":["message","spec"]}},"components/schemas/github.com-mailgun-cerberus-whitelist-WhitelistRespEntry":{"id":"components/schemas/github.com-mailgun-cerberus-whitelist-WhitelistRespEntry","kind":"json-schema","title":"github.com-mailgun-cerberus-whitelist-WhitelistRespEntry","data":{"type":"object","properties":{"ip_address":{"type":"string","description":"Allowlisted IP address"},"description":{"type":"string","description":"Description of the allowlisted IP address"}},"required":["ip_address","description"]}},"components/schemas/github.com-mailgun-cerberus-whitelist-V2WhitelistResp":{"id":"components/schemas/github.com-mailgun-cerberus-whitelist-V2WhitelistResp","kind":"json-schema","title":"github.com-mailgun-cerberus-whitelist-V2WhitelistResp","data":{"type":"object","properties":{"addresses":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-cerberus-whitelist-WhitelistRespEntry"},"description":"Allowlisted IP address entries on the account"}},"required":["addresses"]}},"components/schemas/POST-v2-ip_whitelist-multipart-form-data-RequestBody":{"id":"components/schemas/POST-v2-ip_whitelist-multipart-form-data-RequestBody","kind":"json-schema","title":"POST-v2-ip_whitelist-multipart-form-data-RequestBody","data":{"type":"object","properties":{"address":{"type":"string","description":"Address to be added to the allowlist"},"description":{"type":"string","description":"Description of the address to be added to the allowlist, defaults to empty string"}},"required":["address"]}},"components/schemas/PUT-v2-ip_whitelist-multipart-form-data-RequestBody":{"id":"components/schemas/PUT-v2-ip_whitelist-multipart-form-data-RequestBody","kind":"json-schema","title":"PUT-v2-ip_whitelist-multipart-form-data-RequestBody","data":{"type":"object","properties":{"address":{"type":"string","description":"Address to be updated in the allowlist"},"description":{"type":"string","description":"Description of the address to be updated in the allowlist, defaults to empty string"}},"required":["address"]}},"components/schemas/github.com-mailgun-bounce-classification-entities-Subaccount":{"id":"components/schemas/github.com-mailgun-bounce-classification-entities-Subaccount","kind":"json-schema","title":"github.com-mailgun-bounce-classification-entities-Subaccount","data":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"components/schemas/github.com-mailgun-bounce-classification-entities-Domain":{"id":"components/schemas/github.com-mailgun-bounce-classification-entities-Domain","kind":"json-schema","title":"github.com-mailgun-bounce-classification-entities-Domain","data":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}},"components/schemas/github.com-mailgun-bounce-classification-entities-BouncedStat":{"id":"components/schemas/github.com-mailgun-bounce-classification-entities-BouncedStat","kind":"json-schema","title":"github.com-mailgun-bounce-classification-entities-BouncedStat","data":{"type":"object","properties":{"total":{"type":"integer","format":"int32"}},"required":["total"]}},"components/schemas/github.com-mailgun-bounce-classification-entities-Stat":{"id":"components/schemas/github.com-mailgun-bounce-classification-entities-Stat","kind":"json-schema","title":"github.com-mailgun-bounce-classification-entities-Stat","data":{"type":"object","properties":{"subaccount":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-bounce-classification-entities-Subaccount"},{"type":"null"}]},"domain":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-bounce-classification-entities-Domain"},{"type":"null"}]},"rule-id":{"type":"string"},"entity-id":{"type":"string"},"short-explanation":{"type":"string"},"bounced":{"$ref":"#/components/schemas/github.com-mailgun-bounce-classification-entities-BouncedStat"}},"required":["bounced"]}},"components/schemas/github.com-mailgun-bounce-classification-internal-api-ListStatsResp":{"id":"components/schemas/github.com-mailgun-bounce-classification-internal-api-ListStatsResp","kind":"json-schema","title":"github.com-mailgun-bounce-classification-internal-api-ListStatsResp","data":{"type":"object","properties":{"items":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-bounce-classification-entities-Stat"},{"type":"null"}]}},"_duration":{"type":"string"}},"required":["items","_duration"]}},"components/schemas/github.com-mailgun-bounce-classification-entities-AccountStat":{"id":"components/schemas/github.com-mailgun-bounce-classification-entities-AccountStat","kind":"json-schema","title":"github.com-mailgun-bounce-classification-entities-AccountStat","data":{"type":"object","properties":{"domain":{"$ref":"#/components/schemas/github.com-mailgun-bounce-classification-entities-Domain"},"bounced":{"$ref":"#/components/schemas/github.com-mailgun-bounce-classification-entities-BouncedStat"}},"required":["domain","bounced"]}},"components/schemas/github.com-mailgun-bounce-classification-internal-api-ListAccountStatsResp":{"id":"components/schemas/github.com-mailgun-bounce-classification-internal-api-ListAccountStatsResp","kind":"json-schema","title":"github.com-mailgun-bounce-classification-internal-api-ListAccountStatsResp","data":{"type":"object","properties":{"items":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-bounce-classification-entities-AccountStat"},{"type":"null"}]}},"total":{"type":["integer","null"],"format":"int32"},"req":{"type":"object"}},"required":["items"]}},"components/schemas/github.com-mailgun-bounce-classification-entities-DomainStat":{"id":"components/schemas/github.com-mailgun-bounce-classification-entities-DomainStat","kind":"json-schema","title":"github.com-mailgun-bounce-classification-entities-DomainStat","data":{"type":"object","properties":{"entity-id":{"type":"string"},"entity-name":{"type":"string"},"bounced":{"$ref":"#/components/schemas/github.com-mailgun-bounce-classification-entities-BouncedStat"}},"required":["entity-id","entity-name","bounced"]}},"components/schemas/github.com-mailgun-bounce-classification-internal-api-ListDomainStatsResp":{"id":"components/schemas/github.com-mailgun-bounce-classification-internal-api-ListDomainStatsResp","kind":"json-schema","title":"github.com-mailgun-bounce-classification-internal-api-ListDomainStatsResp","data":{"type":"object","properties":{"items":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-bounce-classification-entities-DomainStat"},{"type":"null"}]}}},"required":["items"]}},"components/schemas/github.com-mailgun-bounce-classification-entities-EntityStat":{"id":"components/schemas/github.com-mailgun-bounce-classification-entities-EntityStat","kind":"json-schema","title":"github.com-mailgun-bounce-classification-entities-EntityStat","data":{"type":"object","properties":{"rule-id":{"type":"string"},"category":{"type":"string"},"severity":{"type":"string"},"sample-text":{"type":"string"},"explanation":{"type":"string"},"bounced":{"$ref":"#/components/schemas/github.com-mailgun-bounce-classification-entities-BouncedStat"}},"required":["rule-id","category","severity","sample-text","explanation","bounced"]}},"components/schemas/github.com-mailgun-bounce-classification-internal-api-ListEntityStatsResp":{"id":"components/schemas/github.com-mailgun-bounce-classification-internal-api-ListEntityStatsResp","kind":"json-schema","title":"github.com-mailgun-bounce-classification-internal-api-ListEntityStatsResp","data":{"type":"object","properties":{"items":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-bounce-classification-entities-EntityStat"},{"type":"null"}]}}},"required":["items"]}},"components/schemas/github.com-mailgun-bounce-classification-internal-config-Entity":{"id":"components/schemas/github.com-mailgun-bounce-classification-internal-config-Entity","kind":"json-schema","title":"github.com-mailgun-bounce-classification-internal-config-Entity","data":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}},"components/schemas/github.com-mailgun-bounce-classification-internal-config-Entities":{"id":"components/schemas/github.com-mailgun-bounce-classification-internal-config-Entities","kind":"json-schema","title":"github.com-mailgun-bounce-classification-internal-config-Entities","data":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/github.com-mailgun-bounce-classification-internal-config-Entity"}}},"components/schemas/github.com-mailgun-bounce-classification-internal-config-Rule":{"id":"components/schemas/github.com-mailgun-bounce-classification-internal-config-Rule","kind":"json-schema","title":"github.com-mailgun-bounce-classification-internal-config-Rule","data":{"type":"object","properties":{"entity_id":{"type":"string"},"class":{"type":"string"},"sample-text":{"type":"string"},"explanation":{"type":"string"},"short-explanation":{"type":"string"}}}},"components/schemas/github.com-mailgun-bounce-classification-internal-config-Rules":{"id":"components/schemas/github.com-mailgun-bounce-classification-internal-config-Rules","kind":"json-schema","title":"github.com-mailgun-bounce-classification-internal-config-Rules","data":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/github.com-mailgun-bounce-classification-internal-config-Rule"}}},"components/schemas/github.com-mailgun-bounce-classification-entities-Resolution":{"id":"components/schemas/github.com-mailgun-bounce-classification-entities-Resolution","kind":"json-schema","title":"github.com-mailgun-bounce-classification-entities-Resolution","data":{"type":"string","enum":["day","hour"],"description":"Resolution of the metrics.","x-enumDescriptions":{"day":"Day","hour":"Hour"}}},"components/schemas/github.com-mailgun-bounce-classification-internal-api-Dimension":{"id":"components/schemas/github.com-mailgun-bounce-classification-internal-api-Dimension","kind":"json-schema","title":"github.com-mailgun-bounce-classification-internal-api-Dimension","data":{"type":"string","enum":["entity-name","domain.name","envelope.sending-ip","account.name","envelope.i-ip-pool-name","tags","tag","recipient-domain","group-id","criticality","severity","category","timestamp"],"description":"Dimension","x-enumDescriptions":{"entity-name":"Recipient Provider/Spam Filter, e.g. Gmail, Other US, Spamcop, etc.","domain.name":"Sender domain name, e.g. example.com","envelope.sending-ip":"Sending IP address","account.name":"Subaccount name","envelope.i-ip-pool-name":"IP Pool name","tags":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags. Not compatible with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dimension."},"children":[]}]}]}],"tag":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag. Not compatible with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dimension."},"children":[]}]}]}],"recipient-domain":"Recipient domain, e.g. gmail.com","group-id":"Group ID","criticality":"Criticality, e.g. CRITICAL or NON-CRITICAL","severity":"Severity, e.g. PERMANENT or TEMPORARY","category":"Category, e.g. BOUNCE, GENERIC, GREYLISTED, ESPBLOCK, etc.","timestamp":"BoD or BoH timestamp (depends on resolution)"}}},"components/schemas/github.com-mailgun-bounce-classification-internal-api-PaginationResp":{"id":"components/schemas/github.com-mailgun-bounce-classification-internal-api-PaginationResp","kind":"json-schema","title":"github.com-mailgun-bounce-classification-internal-api-PaginationResp","data":{"type":"object","properties":{"sort":{"type":"string","description":"'sort' from the request"},"skip":{"type":"integer","format":"int64","description":"'skip' from the request"},"limit":{"type":"integer","format":"int64","description":"'limit' from the request"},"total":{"type":"integer","format":"int64","description":"The total number of items in the query result set."}},"required":["sort","skip","limit","total"]}},"components/schemas/github.com-mailgun-bounce-classification-entities-MetricsCountsAndRates":{"id":"components/schemas/github.com-mailgun-bounce-classification-entities-MetricsCountsAndRates","kind":"json-schema","title":"github.com-mailgun-bounce-classification-entities-MetricsCountsAndRates","data":{"type":"object","properties":{"critical_bounce_count":{"type":"integer","format":"int64"},"non_critical_bounce_count":{"type":"integer","format":"int64"},"critical_delay_count":{"type":"integer","format":"int64"},"non_critical_delay_count":{"type":"integer","format":"int64"},"classified_failures_count":{"type":"integer","format":"int64","description":"Total bounces and delays"},"delivered_smtp_count":{"type":["integer","null"],"format":"int64","description":"null for Spam Filters"},"critical_bounce_rate":{"type":["integer","null"],"format":"int64","description":"Percentages; null for Spam Filters"},"non_critical_bounce_rate":{"type":["integer","null"],"format":"int64","description":"Percentages; null for Spam Filters"},"critical_delay_rate":{"type":["integer","null"],"format":"int64","description":"Percentages; null for Spam Filters"},"non_critical_delay_rate":{"type":["integer","null"],"format":"int64","description":"Percentages; null for Spam Filters"}},"required":["critical_bounce_count","non_critical_bounce_count","critical_delay_count","non_critical_delay_count","classified_failures_count","delivered_smtp_count","critical_bounce_rate","non_critical_bounce_rate","critical_delay_rate","non_critical_delay_rate"]}},"components/schemas/github.com-mailgun-bounce-classification-entities-MetricsItem":{"id":"components/schemas/github.com-mailgun-bounce-classification-entities-MetricsItem","kind":"json-schema","title":"github.com-mailgun-bounce-classification-entities-MetricsItem","data":{"type":"object","properties":{"account.id":{"type":["string","null"]},"account.name":{"type":["string","null"]},"entity-name":{"type":["string","null"]},"recipient-provider":{"type":["string","null"]},"recipient-domain":{"type":["string","null"]},"domain.name":{"type":["string","null"]},"envelope.i-ip-pool-id":{"type":["string","null"]},"envelope.i-ip-pool-name":{"type":["string","null"]},"envelope.sending-ip":{"type":["string","null"]},"timestamp":{"type":["string","null"]},"tags":{"type":["string","null"],"description":"Concatenated tags"},"tag":{"type":["string","null"]},"criticality":{"type":["string","null"]},"severity":{"type":["string","null"]},"category":{"type":["string","null"]},"group-id":{"type":["string","null"]},"sample-text":{"type":["string","null"]},"explanation":{"type":["string","null"]},"metrics":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-bounce-classification-entities-MetricsCountsAndRates"}],"description":"Counts and rates"}},"required":["metrics"]}},"components/schemas/github.com-mailgun-bounce-classification-internal-api-MetricsResponse":{"id":"components/schemas/github.com-mailgun-bounce-classification-internal-api-MetricsResponse","kind":"json-schema","title":"github.com-mailgun-bounce-classification-internal-api-MetricsResponse","data":{"type":"object","properties":{"start":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A start timestamp in RFC 2822 format: https://documentation.mailgun.com/docs/mailgun/api-reference/api-overview#date-format"},"children":[]}]}]}]},"end":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An end timestamp in RFC 2822 format: https://documentation.mailgun.com/docs/mailgun/api-reference/api-overview#date-format"},"children":[]}]}]}]},"resolution":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-bounce-classification-entities-Resolution"}],"description":"'resolution' from the request"},"duration":{"type":"string","description":"'duration' from the request"},"dimensions":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-bounce-classification-internal-api-Dimension"},"description":"'dimensions' from the request"},"pagination":{"$ref":"#/components/schemas/github.com-mailgun-bounce-classification-internal-api-PaginationResp"},"items":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-bounce-classification-entities-MetricsItem"},{"type":"null"}]}}},"required":["start","end","resolution","pagination","items"]}},"components/schemas/github.com-mailgun-holster-v4-clock-RFC822Time":{"id":"components/schemas/github.com-mailgun-holster-v4-clock-RFC822Time","kind":"json-schema","title":"github.com-mailgun-holster-v4-clock-RFC822Time","data":{"type":"object"}},"components/schemas/github.com-mailgun-bounce-classification-internal-api-FilterAttribute":{"id":"components/schemas/github.com-mailgun-bounce-classification-internal-api-FilterAttribute","kind":"json-schema","title":"github.com-mailgun-bounce-classification-internal-api-FilterAttribute","data":{"type":"string","enum":["entity-name","domain.name","envelope.sending-ip","account.name","envelope.i-ip-pool-name","tags","tag","recipient-domain","group-id","criticality","severity","category"],"description":"Filter attribute","x-enumDescriptions":{"entity-name":"Recipient Provider/Spam Filter, e.g. Gmail, Other US, Spamcop, etc.","domain.name":"Sender domain name, e.g. example.com","envelope.sending-ip":"Sending IP address","account.name":"Subaccount name","envelope.i-ip-pool-name":"IP Pool name","tags":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags. Not compatible with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dimension."},"children":[]}]}]}],"tag":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag. Not compatible with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dimension."},"children":[]}]}]}],"recipient-domain":"Recipient domain, e.g. gmail.com","group-id":"Group ID","criticality":"Criticality, e.g. CRITICAL or NON-CRITICAL","severity":"Severity, e.g. PERMANENT or TEMPORARY","category":"Category, e.g. BOUNCE, GENERIC, GREYLISTED, ESPBLOCK, etc."}}},"components/schemas/github.com-mailgun-bounce-classification-internal-api-LabeledValue":{"id":"components/schemas/github.com-mailgun-bounce-classification-internal-api-LabeledValue","kind":"json-schema","title":"github.com-mailgun-bounce-classification-internal-api-LabeledValue","data":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}},"required":["label","value"]}},"components/schemas/github.com-mailgun-bounce-classification-internal-api-FilterPredicate":{"id":"components/schemas/github.com-mailgun-bounce-classification-internal-api-FilterPredicate","kind":"json-schema","title":"github.com-mailgun-bounce-classification-internal-api-FilterPredicate","data":{"type":"object","properties":{"attribute":{"$ref":"#/components/schemas/github.com-mailgun-bounce-classification-internal-api-FilterAttribute"},"comparator":{"type":"string"},"values":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-bounce-classification-internal-api-LabeledValue"}}},"required":["attribute","comparator"]}},"components/schemas/github.com-mailgun-bounce-classification-internal-api-FilterPredicateGroup":{"id":"components/schemas/github.com-mailgun-bounce-classification-internal-api-FilterPredicateGroup","kind":"json-schema","title":"github.com-mailgun-bounce-classification-internal-api-FilterPredicateGroup","data":{"type":"object","properties":{"AND":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-bounce-classification-internal-api-FilterPredicate"}}},"required":["AND"]}},"components/schemas/github.com-mailgun-bounce-classification-internal-api-PaginationReq":{"id":"components/schemas/github.com-mailgun-bounce-classification-internal-api-PaginationReq","kind":"json-schema","title":"github.com-mailgun-bounce-classification-internal-api-PaginationReq","data":{"type":"object","properties":{"sort":{"type":"string","description":"Colon-separated value indicating column name and sort direction e.g. 'entity-name:asc'."},"skip":{"type":"integer","format":"int64","description":"The number of items to skip over when satisfying the request. To get the first page of data set skip to zero. Then increment the skip by the limit for subsequent calls."},"limit":{"type":"integer","maximum":50,"format":"int64","description":"The maximum number of items returned in the response.","default":10}}}},"components/schemas/github.com-mailgun-bounce-classification-internal-api-MetricsRequest":{"id":"components/schemas/github.com-mailgun-bounce-classification-internal-api-MetricsRequest","kind":"json-schema","title":"github.com-mailgun-bounce-classification-internal-api-MetricsRequest","data":{"type":"object","properties":{"start":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-holster-v4-clock-RFC822Time"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A start timestamp (default: 7 days before current time). Must be in RFC 2822 format: https://documentation.mailgun.com/docs/mailgun/api-reference/api-overview#date-format"},"children":[]}]}]}]},"end":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-holster-v4-clock-RFC822Time"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An end timestamp (default: current time). Must be in RFC 2822 format: https://documentation.mailgun.com/docs/mailgun/api-reference/api-overview#date-format"},"children":[]}]}]}]},"resolution":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-bounce-classification-entities-Resolution"}]},"duration":{"type":"string","description":"A duration in the format of '48h' '60m' '30s'. If duration is provided then it is calculated from the end date and overwrites the start date."},"dimensions":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-bounce-classification-internal-api-Dimension"},"description":"Dimensions."},"metrics":{"type":"array","items":{"type":"string"},"description":"Metrics to return. See example."},"filter":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-bounce-classification-internal-api-FilterPredicateGroup"}],"description":"Filters to apply to the query."},"include_subaccounts":{"type":"boolean","description":"Include stats from all subaccounts."},"pagination":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-bounce-classification-internal-api-PaginationReq"}],"description":"Attributes used for pagination and sorting."}}}},"components/schemas/github.com-mailgun-pathfinder-httpapi-Forward":{"id":"components/schemas/github.com-mailgun-pathfinder-httpapi-Forward","kind":"json-schema","title":"github.com-mailgun-pathfinder-httpapi-Forward","data":{"type":"object","properties":{"urls":{"type":"array","items":{"type":"string"}},"recipients":{"type":"array","items":{"type":"string"}},"store":{"type":"string"}},"required":["urls"]}},"components/schemas/github.com-mailgun-pathfinder-httpapi-ForwardsRule":{"id":"components/schemas/github.com-mailgun-pathfinder-httpapi-ForwardsRule","kind":"json-schema","title":"github.com-mailgun-pathfinder-httpapi-ForwardsRule","data":{"type":"object","properties":{"id":{"type":"string"},"account_id":{"type":"string"},"domain_name":{"type":"string"},"domain_id":{"type":"string"},"match":{"type":"string"},"forward":{"$ref":"#/components/schemas/github.com-mailgun-pathfinder-httpapi-Forward"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","account_id","domain_name","domain_id","match","forward","created_at","updated_at"]}},"components/schemas/github.com-mailgun-pathfinder-httpapi-ListForwardsRulesResp":{"id":"components/schemas/github.com-mailgun-pathfinder-httpapi-ListForwardsRulesResp","kind":"json-schema","title":"github.com-mailgun-pathfinder-httpapi-ListForwardsRulesResp","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-pathfinder-httpapi-ForwardsRule"}},"paging":{"$ref":"#/components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingResponse"}},"required":["items","paging"]}},"components/schemas/github.com-mailgun-users-api-UserListResponse":{"id":"components/schemas/github.com-mailgun-users-api-UserListResponse","kind":"json-schema","title":"github.com-mailgun-users-api-UserListResponse","data":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-users-api-UserResponse"}},"total":{"type":"integer","description":"total number of users on the account or the total number of users that match the query"}}}},"components/schemas/github.com-mailgun-users-api-UserResponse":{"id":"components/schemas/github.com-mailgun-users-api-UserResponse","kind":"json-schema","title":"github.com-mailgun-users-api-UserResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"the user ID"},"activated":{"type":"boolean","description":"user activation status"},"name":{"type":"string","description":"full name of user"},"is_disabled":{"type":"boolean","description":"disablement status of user"},"email":{"type":"string","description":"user email address"},"email_details":{"type":"object","properties":{"address":{"type":"string","description":"the full email address"},"is_valid":{"type":"boolean","description":"whether the email address is valid"},"reason":{"type":"string","description":"reason why user email is not valid, if applicable"},"parts":{"type":"object","properties":{"domain":{"type":"string","description":"email domain"},"local_part":{"type":"string","description":"user email identifier"},"display_name":{"type":"string","description":"email display name, if applicable"}}}}},"role":{"type":"string","description":"role of user on the account"},"account_id":{"type":"string","description":"account ID"},"opened_ip":{"type":"string","description":"IP address from which the user opened the account, if applicable"},"is_master":{"type":"boolean","description":"whether the user is the account owner"},"metadata":{"type":"object","description":"any optional metadata for the user"},"tfa_enabled":{"type":"boolean","description":"whether 2-factor auth has been enabled for the user"},"tfa_active":{"type":"boolean","description":"whether 2-factor auth has been activated for the user"},"tfa_created_at":{"example":"2022-12-20T16:52:01.892000","oneOf":[{"type":"string","description":"the date and time at which 2-factor auth was activated in ISO 8601 date-time format without timezone offset (UTC time) and with microseconds","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$"},{"type":"null","description":"2FA is not enabled"}]},"password_updated_at":{"example":"2022-12-20T16:52:01.892000","oneOf":[{"type":"string","description":"the date and time at which the user password was last updated in ISO 8601 date-time format without timezone offset (UTC time) and with microseconds","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$"},{"type":"null","description":"password has not been updated"}]},"preferences":{"type":"object","properties":{"time_zone":{"type":"string","description":"time zone for the user"},"time_format":{"type":"string","description":"preferred timestamp format for the user's in-app experience"},"programming_language":{"type":"string","description":"preferred programming language"}}},"auth":{"type":"object","$ref":"#/components/schemas/github.com-mailgun-users-api-UserAuthResponse"},"github_user_id":{"oneOf":[{"type":"string","description":"Github ID, if part of Github Student Developer Pack account"},{"type":"null"}]},"salesforce_user_id":{"oneOf":[{"type":"string","description":"Salesforce ID, if part of Salesforce platform account"},{"type":"null"}]},"migration_status":{"type":"string","description":"status of migration to Sinch ID for user authentication, if applicable"}}}},"components/schemas/github.com-mailgun-users-api-UserAuthResponse":{"id":"components/schemas/github.com-mailgun-users-api-UserAuthResponse","kind":"json-schema","title":"github.com-mailgun-users-api-UserAuthResponse","data":{"type":"object","properties":{"method":{"type":"string","description":"The user-level auth method"},"prior_method":{"type":"string","description":"The previous auth method for the user, if applicable"},"prior_details":{"type":"object","description":"Details that may be needed for an auth method"}},"required":["method"]}},"components/schemas/github.com-mailgun-users-api-GenericResponse":{"id":"components/schemas/github.com-mailgun-users-api-GenericResponse","kind":"json-schema","title":"github.com-mailgun-users-api-GenericResponse","data":{"type":"object","properties":{"message":{"type":"string","description":"Status message"}},"required":["message"]}},"schema_260":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_260"},"schema_261":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_261"},"schema_262":{"kind":"json-schema","data":{"type":"string","enum":["accepted","clicked","opened","unsubscribed","delivered","permanent_fail","temporary_fail","complained"],"x-enumDescriptions":{"accepted":"The accepted event occurs when Mailgun accepts a message for delivery.","clicked":"The clicked event occurs when a recipient clicks a link in the email. This requires click tracking to be enabled for the domain.","opened":"The opened event occurs when a recipient opens the email. This requires open tracking to be enabled for the domain.","unsubscribed":"The unsubscribed event occurs when a recipient unsubscribes using an unsubscribe mechanism in your email (for example, a list-unsubscribe link).","delivered":"The delivered event occurs when an email is successfully delivered to the recipient's mail server.","permanent_fail":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The permanent_fail event occurs when an email cannot be delivered due to a permanent error."},"children":[]}]}]}],"temporary_fail":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The temporary_fail event occurs when an email cannot be delivered due to a temporary error."},"children":[]}]}]}],"complained":"The complained event occurs when a recipient marks your email as spam or their email provider registers a spam complaint."}},"id":"schema_262"},"schema_263":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","format":"uri"}},"id":"schema_263"},"schema_264":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_264"},"schema_265":{"kind":"json-schema","data":{"type":"string","enum":["yes","no"],"x-enumDescriptions":{"yes":"Sort by ascending time","no":"Do not sort"}},"id":"schema_265"},"schema_266":{"kind":"json-schema","data":{"type":"integer","maximum":300},"id":"schema_266"},"schema_267":{"kind":"json-schema","data":{"$ref":"#/components/schemas/EventSeverityType"},"id":"schema_267"},"schema_268":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EventResponse"}},"paging":{"type":"object","properties":{"next":{"type":"string"},"previous":{"type":"string"}}}}},"id":"schema_268"},"schema_269":{"kind":"json-schema","data":{"type":"object","properties":{"priority":{"type":"integer","description":"Smaller number indicates higher priority. Higher priority routes are handled first. Defaults to 0."},"description":{"type":"string","description":"An arbitrary string."},"expression":{"type":"string","description":"The filtering rule."},"action":{"type":"array","description":"This action is executed when the expression evaluates to True. You can pass multiple parameters.","items":{"type":"string"}}},"required":["expression"]},"id":"schema_269"},"schema_270":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","description":"A string describing the result of the operation"},"route":{"$ref":"#/components/schemas/RouteResponse","description":"The created route"}}},"id":"schema_270"},"schema_271":{"kind":"json-schema","data":{"type":"object","properties":{"total_count":{"type":"integer","description":"Total number of routes in the account"},"items":{"type":"array","items":{"$ref":"#/components/schemas/RouteResponse"},"description":"List of routes"}}},"id":"schema_271"},"schema_272":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","description":"A string describing the error"}}},"id":"schema_272"},"schema_273":{"kind":"json-schema","data":{"type":"object","properties":{"route":{"$ref":"#/components/schemas/RouteResponse"}}},"id":"schema_273"},"schema_274":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the route"},"priority":{"type":"integer","description":"Smaller number indicates higher priority. Higher priority routes are handled first."},"description":{"type":"string","description":"An arbitrary string."},"expression":{"type":"string","description":"The filtering rule."},"action":{"type":"array","description":"This action is executed when the expression evaluates to True. You can pass multiple parameters.","items":{"type":"string"}}}},"id":"schema_274"},"schema_275":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","description":"A string describing the result of the operation"},"route":{"$ref":"#/components/schemas/RouteResponse"}}},"id":"schema_275"},"schema_276":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","description":"A string describing the result of the operation"},"id":{"type":"string","description":"ID of the deleted route"}}},"id":"schema_276"},"schema_277":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string"}}},"id":"schema_277"},"schema_278":{"kind":"json-schema","data":{"type":"object","properties":{"address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid email address for the mailing list, e.g. developers@mailgun.net, or Developers "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:devs@mg.net"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"devs@mg.net"},"children":[]}]}]}]}]},"name":{"type":"string","description":"Mailing list name, e.g. Developers"},"description":{"type":"string","description":"A description"},"access_level":{"type":"string","description":"List access level, one of: readonly, members, everyone. Defaults to readonly"},"reply_preference":{"type":"string","description":"Set where replies should go: list or sender. Defaults to list"}},"required":["address"]},"id":"schema_278"},"schema_279":{"kind":"json-schema","data":{"type":"object","properties":{"list":{"$ref":"#/components/schemas/MailingListResponse"}}},"id":"schema_279"},"schema_280":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","description":"Error message"}}},"id":"schema_280"},"schema_281":{"kind":"json-schema","data":{"type":"object","properties":{"total_count":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/MailingListResponse"}}}},"id":"schema_281"},"schema_282":{"kind":"json-schema","data":{"type":"object","properties":{"total_count":{"type":"integer","description":"Total number of members in the mailing list"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ListMemberResponse"}}}},"id":"schema_282"},"schema_283":{"kind":"json-schema","data":{"type":"object","properties":{"address":{"type":"string","description":"Valid email address specification."},"name":{"type":"string","description":"An optional member name."},"vars":{"type":"object","description":"JSON-encoded dictionary string with arbitrary parameters."},"subscribed":{"type":"boolean","description":"Set the member as subscribed or not. Defaults to true."},"upsert":{"type":"boolean","description":"Set to True to update member if present, False to raise error in case of a duplicate member. Defaults to false."}}},"id":"schema_283"},"schema_284":{"kind":"json-schema","data":{"type":"object","properties":{"member":{"$ref":"#/components/schemas/ListMemberResponse"},"message":{"type":"string","description":"Success message"}}},"id":"schema_284"},"schema_285":{"kind":"json-schema","data":{"oneOf":[{"type":"string"},{"items":{"type":"array","items":{"$ref":"#/components/schemas/ListMemberRequest"}}}]},"id":"schema_285"},"schema_286":{"kind":"json-schema","data":{"type":"object","properties":{"list":{"$ref":"#/components/schemas/MailingListResponse"},"task-id":{"type":"string","description":"Unique identifier for the background upload task"},"message":{"type":"string","description":"Success message"}}},"id":"schema_286"},"schema_287":{"kind":"json-schema","data":{"type":"object","properties":{"subscribed":{"type":"boolean"},"upsert":{"type":"boolean"},"members":{"type":"string","description":"Absolute path to the CSV file"}}},"id":"schema_287"},"schema_288":{"kind":"json-schema","data":{"type":"object","properties":{"address":{"type":"string","description":"A valid email address specification."},"name":{"type":"string","description":"An optional member name."},"vars":{"type":"object","description":"JSON-encoded dictionary string with arbitrary parameters."},"subscribed":{"type":"boolean","description":"Set the member to subscribed or not. Defaults to True."}}},"id":"schema_288"},"schema_289":{"kind":"json-schema","data":{"type":"object","properties":{"member":{"type":"object","properties":{"address":{"type":"string","description":"The email address of the member"}}}}},"id":"schema_289"},"schema_290":{"kind":"json-schema","data":{"type":"object","properties":{"address":{"type":"string","description":"The new mailing list address."},"description":{"type":"string"},"name":{"type":"string"},"access_level":{"type":"string","description":"One of: readonly, members, everyone. Defaults to readonly."},"reply_reference":{"type":"string","description":"Set where replies should go. Can be list or sender. Defaults to list."},"list-id":{"type":"string"}}},"id":"schema_290"},"schema_291":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","description":"Success message"},"list":{"$ref":"#/components/schemas/MailingListResponse"}}},"id":"schema_291"},"schema_292":{"kind":"json-schema","data":{"type":"object","properties":{"address":{"type":"string","description":"The email address of the mailing list"},"message":{"type":"string","description":"Success message"}}},"id":"schema_292"},"schema_293":{"kind":"json-schema","data":{"type":"string","enum":["first","last","next","previous"],"x-enumDescriptions":{"first":"Get the first list's page","last":"Get the last list's page","next":"Get the next list's page","previous":"Get the previous list's page"}},"id":"schema_293"},"schema_294":{"kind":"json-schema","data":{"type":"integer","maximum":500,"minimum":10,"default":10},"id":"schema_294"},"schema_295":{"kind":"json-schema","data":{"type":"integer","maximum":100,"minimum":1},"id":"schema_295"},"schema_296":{"kind":"json-schema","data":{"type":"string","enum":["bounce_rate","complaint_rate","name"],"default":"name","x-enumDescriptions":{"bounce_rate":"Sort domains by bounce rate","complaint_rate":"Sort domains by complaint rate","name":"Sort domains alphabetically by name"}},"id":"schema_296"},"schema_297":{"kind":"json-schema","data":{"type":"string","enum":["ascending","descending"],"default":"ascending","x-enumDescriptions":{"ascending":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort domains ascending by the specified sort_by field"},"children":[]}]}]}],"descending":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort domains descending by the specified sort_by field"},"children":[]}]}]}]}},"id":"schema_297"},"schema_298":{"kind":"json-schema","data":{"type":"integer","maximum":100,"minimum":10,"default":10},"id":"schema_298"},"schema_299":{"kind":"json-schema","data":{"type":"integer","default":0},"id":"schema_299"},"schema_300":{"kind":"json-schema","data":{"type":"string","default":"ascending"},"id":"schema_300"},"schema_301":{"kind":"json-schema","data":{"type":"string","enum":["asc","desc"],"x-enumDescriptions":{"asc":"Sort by ascending order of name field","desc":"Sort by descending order of name field"}},"id":"schema_301"},"schema_302":{"kind":"json-schema","data":{"type":"integer","default":10,"minimum":1,"maximum":1000},"id":"schema_302"},"schema_303":{"kind":"json-schema","data":{"type":"number"},"id":"schema_303"},"schema_304":{"kind":"json-schema","data":{"type":"object","properties":{"email_preview":{"type":"string","format":"json","description":"JSON object encoded as a string","example":"{\"enabled\": false}"},"inbox_placement":{"type":"string","format":"json","description":"JSON object encoded as a string","example":"{\"enabled\": false}"},"sending":{"type":"string","format":"json","description":"JSON object encoded as a string","example":"{\"enabled\": false}"},"validations":{"type":"string","format":"json","description":"JSON object encoded as a string","example":"{\"enabled\": false}"},"validations_bulk":{"type":"string","format":"json","description":"JSON object encoded as a string","example":"{\"enabled\": false}"}}},"id":"schema_304"},"schema_305":{"kind":"json-schema","data":{"type":"object","properties":{"features":{"$ref":"#/components/schemas/github.com-mailgun-accounts-api-FeaturesResponse"}}},"id":"schema_305"},"schema_306":{"kind":"json-schema","data":{"type":"object","properties":{"recipients":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-accounts-api-RecipientResponse"}}}},"id":"schema_306"},"schema_307":{"kind":"json-schema","data":{"type":"object","properties":{"recipient":{"$ref":"#/components/schemas/github.com-mailgun-accounts-api-RecipientResponse"}}},"id":"schema_307"},"schema_308":{"kind":"json-schema","data":{"type":"object","properties":{"webhooks_redact_pii":{"type":"string","format":"json","description":"JSON object encoded as a string","example":"{\"enabled\": false}"},"ai_insights":{"type":"string","format":"json","description":"JSON object encoded as a string","example":"{\"enabled\": false}"}}},"id":"schema_308"},"schema_309":{"kind":"json-schema","data":{"type":"string","enum":["domain","user","web"],"x-enumDescriptions":{"domain":"Filter for domain keys","user":"Filter for user keys","web":"Filter for web keys"}},"id":"schema_309"},"schema_310":{"kind":"json-schema","data":{"type":"integer","default":100},"id":"schema_310"},"schema_311":{"kind":"json-schema","data":{"type":"string","enum":["basic","billing","support","developer","admin"],"x-enumDescriptions":{"basic":"Basic/Analyst user role","billing":"Billing user role","support":"Support user role","developer":"Developer user role","admin":"Admin user role"}},"id":"schema_311"}},"exampleStore":{"paths/~1v3~1{domain_name}~1messages/post/responses/200/content/application~1json/examples/Example":{"value":{"id":"message-id","message":"Queued. Thank you."},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1messages/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1messages/post/responses/400/content/application~1json/examples/Example":{"value":{"message":"A simple message describing the issue - A few examples:'to parameter is not a valid address. please check documentation.' 'Only one parameters 'html' or 'template' is allowed.' 'Need at least one of 'text', 'html', 'amp-html' or 'template' parameters specified.' 'from parameter is missing. ''Send options (parameters starting with o:, h:, or v:) are limited to 16KB total'"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1messages/post/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1messages/post/responses/401/content/application~1json/examples/Example":{"value":"Forbidden","key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1messages/post/responses/401/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1messages/post/responses/429/content/application~1json/examples/Example":{"value":{"message":"Domain example.com is not allowed to send: account-requests-per-sec limit exceeded, try again after 120 seconds"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1messages/post/responses/429/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1messages/post/responses/500/content/application~1json/examples/Example":{"value":{"message":"Internal Server Error"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1messages/post/responses/500/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1messages.mime/post/responses/200/content/application~1json/examples/Example":{"value":{"id":"message-id","message":"Queued. Thank you."},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1messages.mime/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1messages.mime/post/responses/400/content/application~1json/examples/Example":{"value":{"message":"A simple message describing the issue - A few examples:'to parameter is not a valid address. please check documentation.' 'Only one parameters 'html' or 'template' is allowed.' 'Need at least one of 'text', 'html', 'amp-html' or 'template' parameters specified.' 'from parameter is missing. ''Send options (parameters starting with o:, h:, or v:) are limited to 16KB total'"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1messages.mime/post/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1messages.mime/post/responses/401/content/application~1json/examples/Example":{"value":"Forbidden","key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1messages.mime/post/responses/401/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1messages.mime/post/responses/429/content/application~1json/examples/Example":{"value":{"message":"Domain example.com is not allowed to send: account-requests-per-sec limit exceeded, try again after 120 seconds"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1messages.mime/post/responses/429/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1messages.mime/post/responses/500/content/application~1json/examples/Example":{"value":{"message":"Internal Server Error"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1messages.mime/post/responses/500/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain_name}~1messages~1{storage_key}/get/responses/200/content/application~1json/examples/Example":{"value":{"Content-Transfer-Encoding":"7bit","Content-Type":"multipart/form-data; boundary=----SomeFormBoundaryABC123","From":"foo.bar@my-domain.com","Message-Id":"<xxxxxxxxxxxxx.111111111111111@my-domain.com>","Mime-Version":"1.0","Subject":"\"Mailgun is awesome\"","To":"Cool Bar <cool.barr@cool.com>, bar.baz@gmail.com","X-Mailgun-Tag":"Earth","sender":"foo.bar@my-domain.com","recipients":"cool.barr@cool.com, bar.baz@gmail.com","body-html":"<html>This is some html</html>","body-plain":"This is some html","stripped-html":"<html>This is some html</html>","stripped-text":"This is some html","stripped-signature":"the signature block stripped from the plain text message (if found)","message-headers":[["Mime-Version","1.0"],["Subject","\"Mailgun is awesome\""],["From","foo.bar@my-domain.com"],["To","cool.barr@cool.com, bar.baz@gmail.com"],["X-Mailgun-Tag","Earth"],["Message-Id","<xxxxxxxxxxxxx.111111111111111@my-domain.com>"],["Content-Transfer-Encoding","7bit"],["Content-Type","text/html; charset=ascii"]],"X-Mailgun-Template-Name":"my-awesome-template","X-Mailgun-Template-Variables":"{\"name\":\"Foo\",\"phrase\":\"Bar\"}"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain_name}~1messages~1{storage_key}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain_name}~1messages~1{storage_key}/get/responses/404/content/application~1json/examples/Example":{"value":{"message":"Message not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain_name}~1messages~1{storage_key}/get/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain_name}~1messages~1{storage_key}/post/responses/200/content/application~1json/examples/Example":{"value":{"id":"message-id","message":"Queued. Thank you."},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain_name}~1messages~1{storage_key}/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}~1sending_queues/get/responses/200/content/application~1json/examples/Example":{"value":{"regular":{"is_disabled":true,"disabled":{"until":"Mon, 02 Jan 2006 15:04:05 MST","reason":"You have too many messages in queue"}},"scheduled":{"is_disabled":true,"disabled":{"until":"Mon, 02 Jan 2006 15:04:05 MST","reason":"You have too many messages in queue"}}},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}~1sending_queues/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}~1sending_queues/get/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}~1sending_queues/get/responses/401/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}~1sending_queues/get/responses/404/content/application~1json/examples/Example":{"value":{"message":"Domain not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}~1sending_queues/get/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1envelopes/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"done"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1envelopes/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1envelopes/delete/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1envelopes/delete/responses/401/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1envelopes/delete/responses/404/content/application~1json/examples/Example":{"value":{"message":"domain not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1envelopes/delete/responses/404/content/application~1json/examples/Example"},"paths/~1v4~1domains/get/responses/200/content/application~1json/examples/200 without subaccount domains":{"value":{"total_count":1,"items":[{"created_at":"Mon, 02 Jan 2006 15:04:05 MST","id":"1","name":"example.com","state":"unverified","type":"custom","web_prefix":"email","disabled":{"code":"blacklisted","note":"for debugging","permanently":true,"reason":"bad customer"}}]},"key":"200 without subaccount domains","summary":"200 without subaccount domains","id":"paths/~1v4~1domains/get/responses/200/content/application~1json/examples/200 without subaccount domains"},"paths/~1v4~1domains/get/responses/200/content/application~1json/examples/200 with subaccount domains":{"value":{"total_count":1,"items":[{"created_at":"Mon, 02 Jan 2006 15:04:05 MST","id":"1","name":"example.com","subaccount_id":"6fr783930fhhriu673","state":"unverified","type":"custom","web_prefix":"email","disabled":{"code":"blacklisted","note":"for debugging","permanently":true,"reason":"bad customer"}}]},"key":"200 with subaccount domains","summary":"200 with subaccount domains","id":"paths/~1v4~1domains/get/responses/200/content/application~1json/examples/200 with subaccount domains"},"paths/~1v4~1domains/get/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v4~1domains/get/responses/401/content/application~1json/examples/Example"},"paths/~1v4~1domains/post/responses/200/content/application~1json/examples/Example":{"value":{"message":"Domain DNS records have been created","domain":{"created_at":"Thu, 13 Oct 2011 18:02:00 GMT","id":"123456789012345678901234","name":"example.com","require_tls":true,"smtp_login":"postmaster@example.com","spam_action":"disabled","state":"active","type":"sandbox","use_automatic_sender_security":true,"web_prefix":"email","web_scheme":"http","encrypt_incoming_message":true,"message_ttl":86400},"receiving_dns_records":[{"cached":[],"name":"example.com","priority":"10","record_type":"MX","valid":"unknown"}],"sending_dns_records":[{"cached":["mxa.example.com","mxb.example.com"],"name":"example.com","priority":"10","record_type":"A","valid":"valid","value":"1.2.3.4"}]},"key":"Example","summary":"Example","id":"paths/~1v4~1domains/post/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1domains/post/responses/400/content/application~1json/examples/Example":{"value":{"message":"Password is too short. It must be between 5 and 32 characters."},"key":"Example","summary":"Example","id":"paths/~1v4~1domains/post/responses/400/content/application~1json/examples/Example"},"paths/~1v4~1domains/post/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v4~1domains/post/responses/401/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{name}/get/responses/200/content/application~1json/examples/Example":{"value":{"domain":{"created_at":"Thu, 13 Oct 2011 18:02:00 GMT","id":"123456789012345678901234","name":"example.com","require_tls":true,"smtp_login":"postmaster@example.com","spam_action":"disabled","state":"active","type":"sandbox","use_automatic_sender_security":true,"web_prefix":"email","web_scheme":"http"},"receiving_dns_records":[{"is_active":true,"cached":["10 mxa.mailgun.org","10 mxb.mailgun.org"],"priority":"10","record_type":"MX","valid":"valid","value":"mxa.mailgun.org"},{"is_active":true,"cached":["10 mxa.mailgun.org","10 mxb.mailgun.org"],"priority":"10","record_type":"MX","valid":"valid","value":"mxb.mailgun.org"}],"sending_dns_records":[{"is_active":true,"cached":["v=spf1 include:mailgun.org ~all"],"name":"mg.example.com","record_type":"TXT","valid":"valid","value":"v=spf1 include:mailgun.org ~all"},{"is_active":true,"cached":["k=rsa; p=M......"],"name":"mx._domainkey.mg.example.com","record_type":"TXT","valid":"valid","value":"k=rsa; p=M......"},{"is_active":true,"cached":["mailgun.org"],"name":"email.mg.example.com","record_type":"CNAME","valid":"valid","value":"mailgun.org"}]},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{name}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{name}/get/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{name}/get/responses/401/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{name}/get/responses/404/content/application~1json/examples/Example":{"value":{"message":"Domain not found"},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{name}/get/responses/404/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{name}/put/responses/200/content/application~1json/examples/Example":{"value":{"domain":{"created_at":"Thu, 13 Oct 2011 18:02:00 GMT","id":"123456789012345678901234","name":"example.com","require_tls":true,"smtp_login":"postmaster@example.com","spam_action":"disabled","state":"active","type":"sandbox","use_automatic_sender_security":true,"web_prefix":"email","web_scheme":"http"},"receiving_dns_records":[{"cached":[],"name":"example.com","priority":"10","record_type":"MX","valid":"unknown"}],"sending_dns_records":[{"cached":["mxa.example.com","mxb.example.com"],"name":"example.com","priority":"10","record_type":"A","valid":"valid","value":"1.2.3.4"}]},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{name}/put/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{name}/put/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{name}/put/responses/401/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{name}/put/responses/404/content/application~1json/examples/Example":{"value":{"message":"Domain not found"},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{name}/put/responses/404/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{name}~1verify/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"Domain DNS records have been updated","domain":{"created_at":"Mon, 02 Jan 2006 15:04:05 MST","id":"123456789012345678901234","name":"example.com","require_tls":true,"smtp_login":"postmaster@example.com","spam_action":"disabled","state":"unverified","type":"sandbox","use_automatic_sender_security":true,"web_prefix":"email","web_scheme":"http","disabled":{"code":"blacklisted","note":"for debugging","permanently":true,"reason":"bad customer"}},"sending_dns_records":[{"cached":["mxa.example.com","mxb.example.com"],"name":"example.com","priority":"10","record_type":"A","valid":"valid","value":"0.0.0.0"}],"receiving_dns_records":[{"cached":["mxa.example.com","mxb.example.com"],"name":"example.com","priority":"10","record_type":"A","valid":"valid","value":"0.0.0.0"}]},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{name}~1verify/put/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{name}~1verify/put/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{name}~1verify/put/responses/401/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{name}~1verify/put/responses/404/content/application~1json/examples/Example":{"value":{"message":"Domain not found"},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{name}~1verify/put/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"Domain will be deleted in the background"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}/delete/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}/delete/responses/401/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}/delete/responses/404/content/application~1json/examples/Example":{"value":{"message":"Domain not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}/delete/responses/404/content/application~1json/examples/Example"},"paths/~1v1~1dkim~1keys/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"signing_domain":"authority.domain.tld","selector":"s1","dns_record":{"is_active":true,"cached":["cached dns value"],"name":"s1._domainkey.authority.domain.tld","record_type":"TXT","valid":"VALID","value":"expected dns value"}},{"signing_domain":"authority.domain.tld","selector":"s2","dns_record":{"cached":["cached dns value"],"name":"s2._domainkey.authority.domain.tld","record_type":"TXT","valid":"UNKNOWN","value":"expected dns value"}}],"paging":{"previous":"/v1/dkim/keys?page=<previous_page_token>","first":"/v1/dkim/keys","next":"/v1/dkim/keys?page=<encoded_page_token>","last":"/v1/dkim/keys?page=<last_page_token>"}},"key":"Example","summary":"Example","id":"paths/~1v1~1dkim~1keys/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1dkim~1keys/get/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v1~1dkim~1keys/get/responses/401/content/application~1json/examples/Example"},"paths/~1v1~1dkim~1keys/post/responses/200/content/application~1json/examples/Example":{"value":{"signing_domain":"example.com","selector":"s1","dns_record":{"cached":[],"name":"s1._domainkey.example.com","record_type":"TXT","valid":"unknown","value":"k=rsa; p=<public_key>"}},"key":"Example","summary":"Example","id":"paths/~1v1~1dkim~1keys/post/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1dkim~1keys/post/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v1~1dkim~1keys/post/responses/401/content/application~1json/examples/Example"},"paths/~1v1~1dkim~1keys/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"success"},"key":"Example","summary":"Example","id":"paths/~1v1~1dkim~1keys/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1dkim~1keys/delete/responses/400/content/application~1json/examples/Example":{"value":{"message":"cannot delete domain key: must have at least one active domain key"},"key":"Example","summary":"Example","id":"paths/~1v1~1dkim~1keys/delete/responses/400/content/application~1json/examples/Example"},"paths/~1v1~1dkim~1keys/delete/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v1~1dkim~1keys/delete/responses/401/content/application~1json/examples/Example"},"paths/~1v1~1dkim~1keys/delete/responses/404/content/application~1json/examples/Example":{"value":{"message":"domain key not found"},"key":"Example","summary":"Example","id":"paths/~1v1~1dkim~1keys/delete/responses/404/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1activate/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"domain key activated","authority":"authority.domain.tld","selector":"selector","active":true},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1activate/put/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1activate/put/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1activate/put/responses/401/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1activate/put/responses/404/content/application~1json/examples/Example":{"value":{"message":"domain key not found"},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1activate/put/responses/404/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{authority_name}~1keys/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"signing_domain":"authority.domain.tld","selector":"s1","dns_record":{"is_active":true,"cached":["cached dns value"],"name":"s1._domainkey.authority.domain.tld","record_type":"TXT","valid":"VALID","value":"expected dns value"}},{"signing_domain":"authority.domain.tld","selector":"s2","dns_record":{"cached":["cached dns value"],"name":"s2._domainkey.authority.domain.tld","record_type":"TXT","valid":"UNKNOWN","value":"expected dns value"}}]},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{authority_name}~1keys/get/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{authority_name}~1keys/get/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{authority_name}~1keys/get/responses/401/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1deactivate/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"domain key deactivated","authority":"authority.domain.tld","selector":"selector","active":true},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1deactivate/put/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1deactivate/put/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1deactivate/put/responses/401/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1deactivate/put/responses/404/content/application~1json/examples/Example":{"value":{"message":"domain key not found"},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{authority_name}~1keys~1{selector}~1deactivate/put/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}~1dkim_authority/put/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}~1dkim_authority/put/responses/401/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}~1dkim_authority/put/responses/404/content/application~1json/examples/Example":{"value":{"message":"Domain not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}~1dkim_authority/put/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}~1dkim_selector/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"DKIM selector changed"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}~1dkim_selector/put/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}~1dkim_selector/put/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}~1dkim_selector/put/responses/401/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}~1dkim_selector/put/responses/404/content/application~1json/examples/Example":{"value":{"message":"Domain not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}~1dkim_selector/put/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}~1tracking/get/responses/200/content/application~1json/examples/Example":{"value":{"tracking":{"open":{"active":true},"click":{"active":true},"unsubscribe":{"active":true,"html_footer":"off","text_footer":"on"},"web_scheme":"http"}},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}~1tracking/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}~1tracking/get/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}~1tracking/get/responses/401/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}~1tracking/get/responses/404/content/application~1json/examples/Example":{"value":{"message":"Domain not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}~1tracking/get/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}~1tracking~1click/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"Domain tracking settings have been updated","click":{"active":true}},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}~1tracking~1click/put/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}~1tracking~1click/put/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}~1tracking~1click/put/responses/401/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}~1tracking~1click/put/responses/404/content/application~1json/examples/Example":{"value":{"message":"Domain not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}~1tracking~1click/put/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}~1tracking~1open/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"Domain tracking settings have been updated","open":{"active":true}},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}~1tracking~1open/put/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}~1tracking~1open/put/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}~1tracking~1open/put/responses/401/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}~1tracking~1open/put/responses/404/content/application~1json/examples/Example":{"value":{"message":"Domain not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}~1tracking~1open/put/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}~1tracking~1unsubscribe/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"Domain tracking settings have been updated","unsubscribe":{"active":true,"html_footer":"<br>\n<p><a href=\"%unsubscribe_url%\">unsubscribe</a></p>\n","text_footer":"To unsubscribe click: <%unsubscribe_url%>\n\n"}},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}~1tracking~1unsubscribe/put/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}~1tracking~1unsubscribe/put/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}~1tracking~1unsubscribe/put/responses/401/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}~1tracking~1unsubscribe/put/responses/404/content/application~1json/examples/Example":{"value":{"message":"Domain not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}~1tracking~1unsubscribe/put/responses/404/content/application~1json/examples/Example"},"paths/~1v2~1x509~1{domain}~1status/get/responses/200/content/application~1json/examples/Processing":{"value":{"status":"processing","error":"Waiting for x509 key pair generation"},"key":"Processing","summary":"Processing","id":"paths/~1v2~1x509~1{domain}~1status/get/responses/200/content/application~1json/examples/Processing"},"paths/~1v2~1x509~1{domain}~1status/get/responses/200/content/application~1json/examples/Active":{"value":{"status":"active","certificate":"{CERT}"},"key":"Active","summary":"Active","id":"paths/~1v2~1x509~1{domain}~1status/get/responses/200/content/application~1json/examples/Active"},"paths/~1v2~1x509~1{domain}~1status/get/responses/200/content/application~1json/examples/Expired":{"value":{"status":"expired","error":"x509 certificate has expired","certificate":"{CERT}"},"key":"Expired","summary":"Expired","id":"paths/~1v2~1x509~1{domain}~1status/get/responses/200/content/application~1json/examples/Expired"},"paths/~1v2~1x509~1{domain}~1status/get/responses/200/content/application~1json/examples/Error":{"value":{"status":"error","error":"TLS x509 key pair generation failed, please contact support","certificate":"{CERT}"},"key":"Error","summary":"Error","id":"paths/~1v2~1x509~1{domain}~1status/get/responses/200/content/application~1json/examples/Error"},"paths/~1v2~1x509~1{domain}~1status/get/responses/404/content/application~1json/examples/Example":{"value":{"Description":"Please initiate x509 key pair generation at POST /v2/x509/{domain}"},"key":"Example","summary":"Example","id":"paths/~1v2~1x509~1{domain}~1status/get/responses/404/content/application~1json/examples/Example"},"paths/~1v2~1x509~1{domain}/put/responses/202/content/application~1json/examples/Example":{"value":{"message":"Initiated x509 key pair generation","location":"/v2/x509/example.com/status"},"key":"Example","summary":"Example","id":"paths/~1v2~1x509~1{domain}/put/responses/202/content/application~1json/examples/Example"},"paths/~1v2~1x509~1{domain}/put/responses/400/content/application~1json/examples/Example":{"value":{"Reason":"invalid CNAME record"},"key":"Example","summary":"Example","id":"paths/~1v2~1x509~1{domain}/put/responses/400/content/application~1json/examples/Example"},"paths/~1v2~1x509~1{domain}/put/responses/402/content/application~1json/examples/Example":{"value":{"Reason":"upgrade your account to enable this feature"},"key":"Example","summary":"Example","id":"paths/~1v2~1x509~1{domain}/put/responses/402/content/application~1json/examples/Example"},"paths/~1v2~1x509~1{domain}/put/responses/404/content/application~1json/examples/Example":{"value":{"Description":"x509 cert not found"},"key":"Example","summary":"Example","id":"paths/~1v2~1x509~1{domain}/put/responses/404/content/application~1json/examples/Example"},"paths/~1v2~1x509~1{domain}/put/responses/409/content/application~1json/examples/Example":{"value":{"Description":"x509 certificate is still valid until 2009-11-10 23:00:00 +0000 UTC"},"key":"Example","summary":"Example","id":"paths/~1v2~1x509~1{domain}/put/responses/409/content/application~1json/examples/Example"},"paths/~1v2~1x509~1{domain}/put/responses/429/content/application~1json/examples/Example":{"value":{"Description":"x509 key pair generation job is already in progress for example.com"},"key":"Example","summary":"Example","id":"paths/~1v2~1x509~1{domain}/put/responses/429/content/application~1json/examples/Example"},"paths/~1v2~1x509~1{domain}/post/responses/202/content/application~1json/examples/Example":{"value":{"message":"Initiated x509 key pair generation","location":"/v2/x509/example.com/status"},"key":"Example","summary":"Example","id":"paths/~1v2~1x509~1{domain}/post/responses/202/content/application~1json/examples/Example"},"paths/~1v2~1x509~1{domain}/post/responses/400/content/application~1json/examples/Example":{"value":{"Reason":"invalid CNAME record"},"key":"Example","summary":"Example","id":"paths/~1v2~1x509~1{domain}/post/responses/400/content/application~1json/examples/Example"},"paths/~1v2~1x509~1{domain}/post/responses/402/content/application~1json/examples/Example":{"value":{"Reason":"upgrade your account to enable this feature"},"key":"Example","summary":"Example","id":"paths/~1v2~1x509~1{domain}/post/responses/402/content/application~1json/examples/Example"},"paths/~1v2~1x509~1{domain}/post/responses/404/content/application~1json/examples/Example":{"value":{"Description":"x509 cert not found"},"key":"Example","summary":"Example","id":"paths/~1v2~1x509~1{domain}/post/responses/404/content/application~1json/examples/Example"},"paths/~1v2~1x509~1{domain}/post/responses/409/content/application~1json/examples/Example":{"value":{"Description":"x509 key pair generation has already been initiated for example.com"},"key":"Example","summary":"Example","id":"paths/~1v2~1x509~1{domain}/post/responses/409/content/application~1json/examples/Example"},"paths/~1v1~1dkim_management~1domains~1{name}~1rotation/put/responses/200/content/application~1json/examples/Example":{"value":{"domain":{"id":"000000000000000000000002","account_id":"000000000000000000000001","sid":"789","name":"example.com","state":"enabled","active_selector":"pdk1","rotation_enabled":"true","rotation_interval":"24h","records":[{"name":"pdk1._domainkey.example.com","type":"CNAME","identifier":"DKIM","value":"pdk1._domainkey.1234567.service.mailgun.com","comment":"Customer DKIM CNAME Record"},{"name":"pdk2._domainkey.example.com","type":"CNAME","identifier":"DKIM","value":"pdk2._domainkey.1234567.service.mailgun.com","comment":"Customer DKIM CNAME Record"}]}},"key":"Example","summary":"Example","id":"paths/~1v1~1dkim_management~1domains~1{name}~1rotation/put/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1dkim_management~1domains~1{name}~1rotation/put/responses/400/content/application~1json/examples/Example":{"value":{"Reason":"rotation_interval is not allowed unless also enabling DKIM rotation"},"key":"Example","summary":"Example","id":"paths/~1v1~1dkim_management~1domains~1{name}~1rotation/put/responses/400/content/application~1json/examples/Example"},"paths/~1v1~1dkim_management~1domains~1{name}~1rotation/put/responses/404/content/application~1json/examples/Example":{"value":{"Description":"domain not found"},"key":"Example","summary":"Example","id":"paths/~1v1~1dkim_management~1domains~1{name}~1rotation/put/responses/404/content/application~1json/examples/Example"},"paths/~1v1~1dkim_management~1domains~1{name}~1rotate/post/responses/200/content/application~1json/examples/Example":{"value":{"message":"ok"},"key":"Example","summary":"Example","id":"paths/~1v1~1dkim_management~1domains~1{name}~1rotate/post/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1dkim_management~1domains~1{name}~1rotate/post/responses/400/content/application~1json/examples/Example":{"value":{"Reason":"only domains in enabled can rotate their keys. Current state: wait_verify"},"key":"Example","summary":"Example","id":"paths/~1v1~1dkim_management~1domains~1{name}~1rotate/post/responses/400/content/application~1json/examples/Example"},"paths/~1v1~1dkim_management~1domains~1{name}~1rotate/post/responses/404/content/application~1json/examples/Example":{"value":{"Description":"domain not found"},"key":"Example","summary":"Example","id":"paths/~1v1~1dkim_management~1domains~1{name}~1rotate/post/responses/404/content/application~1json/examples/Example"},"paths/~1v1~1webhooks/get/responses/200/content/application~1json/examples/Example":{"value":{"webhooks":[{"webhook_id":"507f1f77bcf86cd799439011","description":"Production alerts webhook","url":"https://api.example.com/webhooks/mailgun","event_types":["delivered","permanent_fail","complained"],"created_at":"2026-02-16T19:06:01Z"},{"webhook_id":"507f1f77bcf86cd799439012","description":"Analytics webhook","url":"https://analytics.example.com/mailgun","event_types":["opened","clicked"],"created_at":"2026-02-16T19:06:01Z"}]},"key":"Example","summary":"Example","id":"paths/~1v1~1webhooks/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1webhooks/get/responses/403/content/application~1json/examples/Example":{"value":{"message":"Forbidden"},"key":"Example","summary":"Example","id":"paths/~1v1~1webhooks/get/responses/403/content/application~1json/examples/Example"},"paths/~1v1~1webhooks/post/responses/200/content/application~1json/examples/Example":{"value":{"webhook_id":"507f1f77bcf86cd799439011"},"key":"Example","summary":"Example","id":"paths/~1v1~1webhooks/post/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1webhooks/post/responses/400/content/application~1json/examples/Example":{"value":{"Field":"event_types","Value":"duplicate event types: 'accepted'"},"key":"Example","summary":"Example","id":"paths/~1v1~1webhooks/post/responses/400/content/application~1json/examples/Example"},"paths/~1v1~1webhooks/post/responses/403/content/application~1json/examples/Example":{"value":{"message":"Forbidden"},"key":"Example","summary":"Example","id":"paths/~1v1~1webhooks/post/responses/403/content/application~1json/examples/Example"},"paths/~1v1~1webhooks/post/responses/404/content/application~1json/examples/Example":{"value":{"Description":"event_type 'invalid_type' is invalid"},"key":"Example","summary":"Example","id":"paths/~1v1~1webhooks/post/responses/404/content/application~1json/examples/Example"},"paths/~1v1~1webhooks/post/responses/409/content/application~1json/examples/Example":{"value":{"Description":"unable to add more than 3 urls for event type delivered"},"key":"Example","summary":"Example","id":"paths/~1v1~1webhooks/post/responses/409/content/application~1json/examples/Example"},"paths/~1v1~1webhooks/delete/responses/400/content/application~1json/examples/Example":{"value":{"message":"Invalid parameter: webhook_ids malformed webhook_ids parameter: empty values not allowed"},"key":"Example","summary":"Example","id":"paths/~1v1~1webhooks/delete/responses/400/content/application~1json/examples/Example"},"paths/~1v1~1webhooks/delete/responses/403/content/application~1json/examples/Example":{"value":{"message":"Forbidden"},"key":"Example","summary":"Example","id":"paths/~1v1~1webhooks/delete/responses/403/content/application~1json/examples/Example"},"paths/~1v1~1webhooks/delete/responses/404/content/application~1json/examples/Example":{"value":{"Description":"no webhooks found for account"},"key":"Example","summary":"Example","id":"paths/~1v1~1webhooks/delete/responses/404/content/application~1json/examples/Example"},"paths/~1v1~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/examples/Example":{"value":{"webhook_id":"507f1f77bcf86cd799439011","description":"Production alerts webhook","url":"https://api.example.com/webhooks/mailgun","event_types":["delivered","permanent_fail","complained"],"created_at":"2026-02-16T19:06:01Z"},"key":"Example","summary":"Example","id":"paths/~1v1~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1webhooks~1{webhook_id}/get/responses/403/content/application~1json/examples/Example":{"value":{"message":"Forbidden"},"key":"Example","summary":"Example","id":"paths/~1v1~1webhooks~1{webhook_id}/get/responses/403/content/application~1json/examples/Example"},"paths/~1v1~1webhooks~1{webhook_id}/get/responses/404/content/application~1json/examples/Example":{"value":{"Description":"webhook not found"},"key":"Example","summary":"Example","id":"paths/~1v1~1webhooks~1{webhook_id}/get/responses/404/content/application~1json/examples/Example"},"paths/~1v1~1webhooks~1{webhook_id}/put/responses/400/content/application~1json/examples/Example":{"value":{"Field":"url","Value":"missing or invalid url parameter"},"key":"Example","summary":"Example","id":"paths/~1v1~1webhooks~1{webhook_id}/put/responses/400/content/application~1json/examples/Example"},"paths/~1v1~1webhooks~1{webhook_id}/put/responses/403/content/application~1json/examples/Example":{"value":{"message":"Forbidden"},"key":"Example","summary":"Example","id":"paths/~1v1~1webhooks~1{webhook_id}/put/responses/403/content/application~1json/examples/Example"},"paths/~1v1~1webhooks~1{webhook_id}/put/responses/404/content/application~1json/examples/Example":{"value":{"Description":"webhook_id not found: 507f1f77bcf86cd799439011"},"key":"Example","summary":"Example","id":"paths/~1v1~1webhooks~1{webhook_id}/put/responses/404/content/application~1json/examples/Example"},"paths/~1v1~1webhooks~1{webhook_id}/put/responses/409/content/application~1json/examples/Example":{"value":{"Description":"url https://example.com already exists for event type delivered"},"key":"Example","summary":"Example","id":"paths/~1v1~1webhooks~1{webhook_id}/put/responses/409/content/application~1json/examples/Example"},"paths/~1v1~1webhooks~1{webhook_id}/delete/responses/400/content/application~1json/examples/Example":{"value":{"Field":"webhook_id","Value":"is not valid"},"key":"Example","summary":"Example","id":"paths/~1v1~1webhooks~1{webhook_id}/delete/responses/400/content/application~1json/examples/Example"},"paths/~1v1~1webhooks~1{webhook_id}/delete/responses/403/content/application~1json/examples/Example":{"value":{"message":"Forbidden"},"key":"Example","summary":"Example","id":"paths/~1v1~1webhooks~1{webhook_id}/delete/responses/403/content/application~1json/examples/Example"},"paths/~1v1~1webhooks~1{webhook_id}/delete/responses/404/content/application~1json/examples/Example":{"value":{"Description":"webhook_id not found: 507f1f77bcf86cd799439011"},"key":"Example","summary":"Example","id":"paths/~1v1~1webhooks~1{webhook_id}/delete/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain}~1webhooks/get/responses/200/content/application~1json/examples/Example":{"value":{"webhooks":{"accepted":{"urls":["https://foo.com","https://bar.com"]},"delivered":{"urls":["https://foo.com","https://bar.com"]},"opened":{"urls":["https://foo.com","https://bar.com"]},"clicked":{"urls":["https://foo.com","https://bar.com"]},"unsubscribed":{"urls":["https://foo.com","https://bar.com"]},"complained":{"urls":["https://foo.com","https://bar.com"]},"temporary_fail":{"urls":["https://foo.com","https://bar.com"]},"permanent_fail":{"urls":["https://foo.com","https://bar.com"]}}},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain}~1webhooks/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain}~1webhooks/get/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain}~1webhooks/get/responses/401/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain}~1webhooks/get/responses/404/content/application~1json/examples/Example":{"value":{"message":"Domain not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain}~1webhooks/get/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain}~1webhooks/post/responses/200/content/application~1json/examples/Example":{"value":{"message":"Webhook has been created","webhook":{"urls":["https://foo.com","https://bar.com"]}},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain}~1webhooks/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain}~1webhooks/post/responses/400/content/application~1json/examples/Example":{"value":{"Reason":"https://example.com/ is not a valid url: host not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain}~1webhooks/post/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain}~1webhooks/post/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain}~1webhooks/post/responses/401/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain}~1webhooks/post/responses/404/content/application~1json/examples/Example":{"value":{"message":"Domain not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain}~1webhooks/post/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/get/responses/200/content/application~1json/examples/Example":{"value":{"webhook":{"urls":["https://foo.com"]}},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/get/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/get/responses/401/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/get/responses/404/content/application~1json/examples/Example":{"value":{"message":"Domain not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/get/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"Webhook has been updated","webhook":{"urls":["https://foo.com"]}},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/responses/400/content/application~1json/examples/Example":{"value":{"Reason":"https://example.com/ is not a valid url: host not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/responses/401/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/responses/404/content/application~1json/examples/Example":{"value":{"message":"Domain not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/put/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"Webhook has been deleted","webhook":{"urls":["https://foo.com"]}},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/delete/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/delete/responses/401/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/delete/responses/404/content/application~1json/examples/Example":{"value":{"message":"Domain not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain_name}~1webhooks~1{webhook_name}/delete/responses/404/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{domain}~1webhooks/put/responses/200/content/application~1json/examples/Example":{"value":{"webhooks":{"delivered":{"urls":["https://example.com/webhooks"]},"opened":{"urls":["https://example.com/webhooks"]},"clicked":{"urls":["https://foo.com"]}}},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{domain}~1webhooks/put/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{domain}~1webhooks/put/responses/400/content/application~1json/examples/Example":{"value":{"Reason":"invalid parameters: https://invalid is not a valid url: invalid URL scheme"},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{domain}~1webhooks/put/responses/400/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{domain}~1webhooks/put/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{domain}~1webhooks/put/responses/401/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{domain}~1webhooks/put/responses/404/content/application~1json/examples/Example":{"value":{"Description":"Webhook not found"},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{domain}~1webhooks/put/responses/404/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{domain}~1webhooks/post/responses/200/content/application~1json/examples/Example":{"value":{"webhooks":{"accepted":{"urls":["https://example.com/webhooks"]},"delivered":{"urls":["https://example.com/webhooks"]},"clicked":{"urls":["https://foo.com"]},"permanent_fail":{"urls":["https://bar.com"]}}},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{domain}~1webhooks/post/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{domain}~1webhooks/post/responses/400/content/application~1json/examples/Example":{"value":{"Reason":"Webhook for event type 'clicked' with URL 'https://example.com/webhooks' already exists"},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{domain}~1webhooks/post/responses/400/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{domain}~1webhooks/post/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{domain}~1webhooks/post/responses/401/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{domain}~1webhooks/post/responses/404/content/application~1json/examples/Example":{"value":{"message":"Domain not found"},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{domain}~1webhooks/post/responses/404/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{domain}~1webhooks/delete/responses/200/content/application~1json/examples/Example":{"value":{"webhooks":{"delivered":{"urls":["https://example.com/webhooks"]},"clicked":{"urls":["https://foo.com"]}}},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{domain}~1webhooks/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{domain}~1webhooks/delete/responses/400/content/application~1json/examples/Example":{"value":{"Field":"url"},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{domain}~1webhooks/delete/responses/400/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{domain}~1webhooks/delete/responses/401/content/application~1json/examples/Example":{"value":{"message":"Invalid private key"},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{domain}~1webhooks/delete/responses/401/content/application~1json/examples/Example"},"paths/~1v4~1domains~1{domain}~1webhooks/delete/responses/404/content/application~1json/examples/Example":{"value":{"message":"Domain not found"},"key":"Example","summary":"Example","id":"paths/~1v4~1domains~1{domain}~1webhooks/delete/responses/404/content/application~1json/examples/Example"},"paths/~1v1~1analytics~1metrics/post/requestBody/content/application~1json/examples/Example":{"value":{"start":"Mon, 13 Nov 2023 20:56:50 -0600","end":"Wed, 20 Dec 2023 20:56:50 -0600","resolution":"month","duration":"1m","dimensions":["time"],"metrics":["accepted_count","delivered_count","clicked_rate","opened_rate"],"filter":{"AND":[{"attribute":"domain","comparator":"=","values":[{"label":"example.com","value":"example.com"}]}]},"include_subaccounts":true,"include_aggregates":true},"key":"Example","summary":"Example","id":"paths/~1v1~1analytics~1metrics/post/requestBody/content/application~1json/examples/Example"},"paths/~1v1~1analytics~1metrics/post/requestBody/content/none/examples/Example":{"key":"Example","summary":"Example","id":"paths/~1v1~1analytics~1metrics/post/requestBody/content/none/examples/Example"},"paths/~1v1~1analytics~1metrics/post/responses/200/content/application~1json/examples/Example":{"value":{"start":"Mon, 13 Nov 2023 20:56:50 -0600","end":"Wed, 20 Dec 2023 20:56:50 -0600","resolution":"month","duration":"1m","pagination":{"sort":"timestamp:asc","skip":1,"limit":10,"total":1000},"items":[{"dimensions":[{"dimension":"time","value":"Wed, 01 Nov 2023 00:00:00 +0000","display_value":"Wed, 01 Nov 2023 00:00:00 +0000"}],"metrics":{"accepted_incoming_count":10,"accepted_outgoing_count":30,"accepted_count":40,"delivered_smtp_count":40,"delivered_http_count":20,"delivered_optimized_count":0,"delivered_count":60,"opened_count":55,"clicked_count":50,"clicked_rate":"0.8300"}},{"dimensions":[{"dimension":"time","value":"Fri, 01 Dec 2023 00:00:00 +0000","display_value":"Fri, 01 Dec 2023 00:00:00 +0000"}],"metrics":{"accepted_incoming_count":10,"accepted_outgoing_count":30,"accepted_count":40,"delivered_smtp_count":40,"delivered_http_count":20,"delivered_optimized_count":0,"delivered_count":60,"opened_count":55,"clicked_count":50,"clicked_rate":"0.8300"}}],"aggregates":{"metrics":{}}},"key":"Example","summary":"Example","id":"paths/~1v1~1analytics~1metrics/post/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1analytics~1metrics/post/responses/400/content/application~1json/examples/Example":{"value":{"message":"reason for bad request"},"key":"Example","summary":"Example","id":"paths/~1v1~1analytics~1metrics/post/responses/400/content/application~1json/examples/Example"},"paths/~1v1~1analytics~1usage~1metrics/post/requestBody/content/application~1json/examples/Example":{"value":{"start":"Mon, 13 Nov 2023 20:56:50 -0600","end":"Wed, 20 Dec 2023 20:56:50 -0600","resolution":"month","duration":"1m","dimensions":["time"],"metrics":["accessibility_count","accessibility_failed_count","archived_count","domain_blocklist_monitoring_count","email_preview_count","email_preview_failed_count","email_validation_bulk_count","email_validation_count","email_validation_list_count","email_validation_mailgun_count","email_validation_mailjet_count","email_validation_public_count","email_validation_single_count","email_validation_valid_count","image_validation_count","image_validation_failed_count","spam_content_check_count","spam_content_check_failed_count","ip_blocklist_monitoring_count","link_validation_count","link_validation_failed_count","processed_count","seed_test_count"],"filter":{"AND":[{"attribute":"subaccount","comparator":"=","values":[{"label":"12345","value":"12345"}]}]},"include_subaccounts":true,"include_aggregates":true},"key":"Example","summary":"Example","id":"paths/~1v1~1analytics~1usage~1metrics/post/requestBody/content/application~1json/examples/Example"},"paths/~1v1~1analytics~1usage~1metrics/post/requestBody/content/none/examples/Example":{"key":"Example","summary":"Example","id":"paths/~1v1~1analytics~1usage~1metrics/post/requestBody/content/none/examples/Example"},"paths/~1v1~1analytics~1usage~1metrics/post/responses/200/content/application~1json/examples/Example":{"value":{"start":"Mon, 13 Nov 2023 20:56:50 -0600","end":"Wed, 20 Dec 2023 20:56:50 -0600","resolution":"month","duration":"1m","pagination":{"sort":"timestamp:asc","skip":1,"limit":10,"total":1000},"items":[{"dimensions":[{"dimension":"time","value":"Wed, 01 Nov 2023 00:00:00 +0000","display_value":"Wed, 01 Nov 2023 00:00:00 +0000"}],"metrics":{"processed_count":3,"email_validation_count":50,"email_validation_public_count":55,"email_validation_valid_count":10,"email_validation_single_count":30,"email_validation_bulk_count":40,"email_validation_list_count":20,"email_validation_mailgun_count":40,"email_validation_mailjet_count":5,"email_preview_count":60,"email_preview_failed_count":16,"link_validation_count":5,"link_validation_failed_count":7,"seed_test_count":9,"ip_blocklist_monitoring_count":42,"domain_blocklist_monitoring_count":1001}},{"dimensions":[{"dimension":"time","value":"Fri, 01 Dec 2023 00:00:00 +0000","display_value":"Fri, 01 Dec 2023 00:00:00 +0000"}],"metrics":{"processed_count":3,"email_validation_count":50,"email_validation_public_count":55,"email_validation_valid_count":10,"email_validation_single_count":30,"email_validation_bulk_count":40,"email_validation_list_count":20,"email_validation_mailgun_count":40,"email_validation_mailjet_count":5,"email_preview_count":60,"email_preview_failed_count":16,"link_validation_count":5,"link_validation_failed_count":7,"seed_test_count":9,"ip_blocklist_monitoring_count":42,"domain_blocklist_monitoring_count":1001}}],"aggregates":{"metrics":{}}},"key":"Example","summary":"Example","id":"paths/~1v1~1analytics~1usage~1metrics/post/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1analytics~1usage~1metrics/post/responses/400/content/application~1json/examples/Example":{"value":{"message":"reason for bad request"},"key":"Example","summary":"Example","id":"paths/~1v1~1analytics~1usage~1metrics/post/responses/400/content/application~1json/examples/Example"},"paths/~1v1~1analytics~1logs/post/requestBody/content/application~1json/examples/Example":{"value":{"start":"Mon, 08 Jul 2024 00:00:00 -0000","end":"Fri, 12 Jul 2024 00:00:00 -0000","filter":{"AND":[{"attribute":"domain","comparator":"=","values":[{"label":"example.com","value":"example.com"}]}]},"include_subaccounts":true,"pagination":{"sort":"timestamp:asc","token":"cjsijbijewbu78t678tVTYUYU76754fyuiksin865g","limit":50}},"key":"Example","summary":"Example","id":"paths/~1v1~1analytics~1logs/post/requestBody/content/application~1json/examples/Example"},"paths/~1v1~1analytics~1logs/post/responses/200/content/application~1json/examples/Example":{"value":{"start":"Mon, 08 Jul 2024 00:00:00 -0000","end":"Fri, 12 Jul 2024 00:00:00 -0000","items":[{"id":"JDhSWf9mT5OFxCkZfpDU5d","event":"failed","@timestamp":"2024-07-08T16:30:18.530Z","account":{"id":"12345"},"delivery-status":{"message":"Turret client: server connection failed","attempt-no":5,"code":680,"session-seconds":15.026,"retry-seconds":145},"domain":{"name":"example.com"},"recipient":"example@gmail.com","recipient-domain":"gmail.com","recipient-provider":"Gmail","envelope":{"sender":"bob@example.com","transport":"smtp","sending-ip":"198.52.100.1","targets":"bob@example.com"}}],"pagination":{"previous":"cjsijbijewbu78t678tVTYUYU76754fyuiksi23h75","next":"cjsijbijewbu78t678tVTYUYU76754fyuiksin98hh","first":"cjsijbijewbu78t678tVTYUYU76754fyuiksin865g","last":"875bunjnWkmis75bjklnsdk0s7jksnjknlknc64aTR","total":100},"aggregates":{}},"key":"Example","summary":"Example","id":"paths/~1v1~1analytics~1logs/post/responses/200/content/application~1json/examples/Example"},"paths/~1v2~1bounce-classification~1metrics/post/requestBody/content/application~1json/examples/Example":{"value":{"start":"Sun, 01 Jan 2006 22:04:05 UTC","end":"Mon, 02 Jan 2006 22:04:05 UTC","resolution":"day","duration":"24h0m0s","dimensions":["entity-name","domain.name"],"metrics":["critical_bounce_count","non_critical_bounce_count","critical_delay_count","non_critical_delay_count","delivered_smtp_count","classified_failures_count","critical_bounce_rate","non_critical_bounce_rate","critical_delay_rate","non_critical_delay_rate"],"filter":{"AND":[{"attribute":"domain.name","comparator":"=","values":[{"value":"example.com"}]}]},"include_subaccounts":true,"pagination":{"sort":"entity-name:asc","limit":10}},"key":"Example","summary":"Example","id":"paths/~1v2~1bounce-classification~1metrics/post/requestBody/content/application~1json/examples/Example"},"paths/~1v2~1bounce-classification~1metrics/post/responses/200/content/application~1json/examples/Example":{"value":{"start":"Sun, 01 Jan 2006 22:04:05 +0000","end":"Mon, 02 Jan 2006 22:04:05 +0000","resolution":"day","duration":"24h0m0s","dimensions":["entity-name","domain.name"],"pagination":{"sort":"entity-name:asc","limit":10,"total":1},"items":[{"account.name":"subaccount name","entity-name":"Gmail","domain.name":"example.com","envelope.i-ip-pool-name":"default","envelope.sending-ip":"1.2.3.4","timestamp":"Mon, 02 Jan 2006 22:04:05 +0000","tags":"daily, campaign1","metrics":{"critical_bounce_count":10,"non_critical_bounce_count":20,"critical_delay_count":30,"non_critical_delay_count":40,"classified_failures_count":100,"delivered_smtp_count":1000,"critical_bounce_rate":1,"non_critical_bounce_rate":2,"critical_delay_rate":3,"non_critical_delay_rate":4}}]},"key":"Example","summary":"Example","id":"paths/~1v2~1bounce-classification~1metrics/post/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1bounce-classification~1stats/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"subaccount":{"id":"subaccount_id"},"domain":{"name":"example.com"},"rule-id":"55ff","entity-id":"spamhaus","short-explanation":"You're listed on Spamhaus!","bounced":{"total":4}}],"_duration":"0s"},"key":"Example","summary":"Example","id":"paths/~1v1~1bounce-classification~1stats/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1bounce-classification~1domains/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"domain":{"name":"mailgun.net"},"bounced":{"total":4}}],"total":1},"key":"Example","summary":"Example","id":"paths/~1v1~1bounce-classification~1domains/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1bounce-classification~1domains~1{domain}~1entities/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"entity-id":"gmail","entity-name":"Gmail","bounced":{"total":1}},{"entity-id":"hotmail","entity-name":"Microsoft (Hotmail)","bounced":{"total":3}}]},"key":"Example","summary":"Example","id":"paths/~1v1~1bounce-classification~1domains~1{domain}~1entities/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1bounce-classification~1domains~1{domain}~1entities~1{entity-id}~1rules/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"rule-id":"55ff","category":"ESPBLOCK","severity":"PERMANENT","sample-text":"5.4.1 recipient address rejected: access denied.","explanation":"Access denied","bounced":{"total":3}}]},"key":"Example","summary":"Example","id":"paths/~1v1~1bounce-classification~1domains~1{domain}~1entities~1{entity-id}~1rules/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1bounce-classification~1config~1entities/get/responses/200/content/application~1json/examples/Example":{"key":"Example","summary":"Example","id":"paths/~1v1~1bounce-classification~1config~1entities/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1bounce-classification~1config~1rules/get/responses/200/content/application~1json/examples/Example":{"key":"Example","summary":"Example","id":"paths/~1v1~1bounce-classification~1config~1rules/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1analytics~1tags/put/requestBody/content/application~1json/examples/Example":{"value":{"tag":"name-of-tag-to-update","description":"updated tag description"},"key":"Example","summary":"Example","id":"paths/~1v1~1analytics~1tags/put/requestBody/content/application~1json/examples/Example"},"paths/~1v1~1analytics~1tags/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"Tag updated"},"key":"Example","summary":"Example","id":"paths/~1v1~1analytics~1tags/put/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1analytics~1tags/post/requestBody/content/application~1json/examples/Example":{"value":{"pagination":{"sort":"lastseen:desc","limit":10},"include_subaccounts":true},"key":"Example","summary":"Example","id":"paths/~1v1~1analytics~1tags/post/requestBody/content/application~1json/examples/Example"},"paths/~1v1~1analytics~1tags/post/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"account_id":"12345","parent_account_id":"12345","tag":"tag1","description":"tag used to identify campaign 1","first_seen":{},"last_seen":{},"metrics":{},"account_name":"account1"},{"account_id":"67890","parent_account_id":"12345","tag":"tag2","description":"tag used to identify campaign 2","first_seen":{},"last_seen":{},"metrics":{},"account_name":"account2"}],"pagination":{"sort":"lastseen:desc","limit":10,"total":2}},"key":"Example","summary":"Example","id":"paths/~1v1~1analytics~1tags/post/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1analytics~1tags/post/responses/400/content/application~1json/examples/Example":{"value":{"message":"reason for bad request"},"key":"Example","summary":"Example","id":"paths/~1v1~1analytics~1tags/post/responses/400/content/application~1json/examples/Example"},"paths/~1v1~1analytics~1tags/delete/requestBody/content/application~1json/examples/Example":{"value":{"tag":"name-of-tag-to-delete"},"key":"Example","summary":"Example","id":"paths/~1v1~1analytics~1tags/delete/requestBody/content/application~1json/examples/Example"},"paths/~1v1~1analytics~1tags/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"Tag deleted"},"key":"Example","summary":"Example","id":"paths/~1v1~1analytics~1tags/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1stats~1total/get/responses/200/content/application~1json/examples/Example":{"value":{"description":"Optional Description","start":"Tue, 14 Feb 2012 00:00:00 UTC","end":"Fri, 01 Apr 2012 00:00:00 UTC","resolution":"month","stats":[{"time":"Fri, 01 Apr 2012 00:00:00 UTC","accepted":{"incoming":2,"outgoing":1,"total":3},"delivered":{"smtp":15,"http":10,"optimized":5,"total":20},"opened":{"total":20,"unique":1},"clicked":{"total":1,"unique":1}}]},"key":"Example","summary":"Example","id":"paths/~1v3~1stats~1total/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1stats~1total/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"reason for bad request"},"key":"Example","summary":"Example","id":"paths/~1v3~1stats~1total/get/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1{domain}~1stats~1total/get/responses/200/content/application~1json/examples/Example":{"value":{"description":"Optional Description","start":"Tue, 14 Feb 2012 00:00:00 UTC","end":"Fri, 01 Apr 2012 00:00:00 UTC","resolution":"month","stats":[{"time":"Fri, 01 Apr 2012 00:00:00 UTC","accepted":{"incoming":2,"outgoing":1,"total":3},"delivered":{"smtp":15,"http":10,"optimized":5,"total":20},"opened":{"total":20,"unique":1},"clicked":{"total":1,"unique":1}}]},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain}~1stats~1total/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain}~1stats~1total/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"reason for bad request"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain}~1stats~1total/get/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1stats~1total~1domains/get/responses/200/content/application~1json/examples/Example":{"value":{"description":"Optional Description","start":"Tue, 14 Feb 2012 00:00:00 UTC","end":"Fri, 01 Apr 2012 00:00:00 UTC","resolution":"month","stats":[{"time":"Fri, 01 Apr 2012 00:00:00 UTC","accepted":{"incoming":2,"outgoing":1,"total":3},"delivered":{"smtp":15,"http":10,"optimized":5,"total":20},"opened":{"total":20,"unique":1},"clicked":{"total":1,"unique":1}}]},"key":"Example","summary":"Example","id":"paths/~1v3~1stats~1total~1domains/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1stats~1total~1domains/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"reason for bad request"},"key":"Example","summary":"Example","id":"paths/~1v3~1stats~1total~1domains/get/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1stats~1filter/get/responses/200/content/application~1json/examples/Example":{"value":{"description":"Optional Description","start":"Tue, 14 Feb 2012 00:00:00 UTC","end":"Fri, 01 Apr 2012 00:00:00 UTC","resolution":"month","stats":[{"time":"Fri, 01 Apr 2012 00:00:00 UTC","accepted":{"incoming":2,"outgoing":1,"total":3},"delivered":{"smtp":15,"http":10,"optimized":5,"total":20},"opened":{"total":20,"unique":1},"clicked":{"total":1,"unique":1}}]},"key":"Example","summary":"Example","id":"paths/~1v3~1stats~1filter/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1stats~1filter/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"reason for bad request"},"key":"Example","summary":"Example","id":"paths/~1v3~1stats~1filter/get/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1{domain}~1aggregates~1providers/get/responses/200/content/application~1json/examples/Example":{"value":{"providers":{"aol.com":{"accepted":0,"clicked":1,"opened":1,"unique_clicked":1,"unsubscribed":0},"gmail.com":{"accepted":0,"clicked":2,"opened":1,"unique_clicked":1,"unsubscribed":0}}},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain}~1aggregates~1providers/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain}~1aggregates~1providers/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"reason for bad request"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain}~1aggregates~1providers/get/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1{domain}~1aggregates~1devices/get/responses/200/content/application~1json/examples/Example":{"value":{"devices":{"desktop":{"accepted":0,"clicked":1,"opened":1,"unique_clicked":1,"unsubscribed":0},"mobile":{"accepted":0,"clicked":2,"opened":1,"unique_clicked":1,"unsubscribed":0},"tablet":{"accepted":0,"clicked":2,"opened":1,"unique_clicked":1,"unsubscribed":0},"unknown":{"accepted":0,"clicked":2,"opened":1,"unique_clicked":1,"unsubscribed":0}}},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain}~1aggregates~1devices/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain}~1aggregates~1devices/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"reason for bad request"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain}~1aggregates~1devices/get/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1{domain}~1aggregates~1countries/get/responses/200/content/application~1json/examples/Example":{"value":{"countries":{"ru":{"accepted":0,"clicked":2,"opened":1,"unique_clicked":1,"unsubscribed":0},"us":{"accepted":0,"clicked":1,"opened":1,"unique_clicked":1,"unsubscribed":0}}},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain}~1aggregates~1countries/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain}~1aggregates~1countries/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"reason for bad request"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain}~1aggregates~1countries/get/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1{domain}~1tags/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"tag":"my-tag-1","description":"Optional description","first-seen":"2023-01-02 02:14:27 +0000 UTC","last-seen":"2023-09-06 18:45:51 +0000 UTC"},{"tag":"my-tag-2","description":"Optional description","first-seen":"2023-01-02 02:14:27 +0000 UTC","last-seen":"2023-09-06 18:45:51 +0000 UTC"}],"paging":{"previous":"https://api.mailgun.net/v3/example.com/tags?limit=1000&page=prev&tag=","first":"https://api.mailgun.net/v3/example.com/tags?limit=1000&page=first&tag=","next":"https://api.mailgun.net/v3/example.com/tags?limit=1000&page=next&tag=","last":"https://api.mailgun.net/v3/example.com/tags?limit=1000&page=last&tag="}},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain}~1tags/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain}~1tags/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"reason for bad request"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain}~1tags/get/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1{domain}~1tag/get/responses/200/content/application~1json/examples/Example":{"value":{"tag":"my-tag-1","description":"Optional description","first-seen":"2023-01-02 02:14:27 +0000 UTC","last-seen":"2023-09-06 18:45:51 +0000 UTC"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain}~1tag/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain}~1tag/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"reason for bad request"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain}~1tag/get/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1{domain}~1tag/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"Tag updated"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain}~1tag/put/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain}~1tag/put/responses/400/content/application~1json/examples/Example":{"value":{"message":"reason for bad request"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain}~1tag/put/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1{domain}~1tag/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"Tag deleted"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain}~1tag/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain}~1tag/delete/responses/400/content/application~1json/examples/Example":{"value":{"message":"reason for bad request"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain}~1tag/delete/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1{domain}~1tag~1stats~1aggregates/get/responses/200/content/application~1json/examples/Example":{"value":{"tag":"tag1","provider":{"aol.com":{"accepted":0,"clicked":1,"opened":1,"unique_clicked":1,"unsubscribed":0},"gmail.com":{"accepted":0,"clicked":2,"opened":1,"unique_clicked":1,"unsubscribed":0}}},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain}~1tag~1stats~1aggregates/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain}~1tag~1stats~1aggregates/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"reason for bad request"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain}~1tag~1stats~1aggregates/get/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1{domain}~1tag~1stats/get/responses/200/content/application~1json/examples/Example":{"value":{"tag":"tag1","description":"Optional Description","start":"Tue, 14 Feb 2012 00:00:00 UTC","end":"Fri, 01 Apr 2012 00:00:00 UTC","resolution":"month","stats":[{"time":"Fri, 01 Apr 2012 00:00:00 UTC","accepted":{"incoming":2,"outgoing":1,"total":3},"delivered":{"smtp":15,"http":10,"optimized":5,"total":20},"opened":{"total":20,"unique":1},"clicked":{"total":1,"unique":1}}]},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain}~1tag~1stats/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain}~1tag~1stats/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"reason for bad request"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain}~1tag~1stats/get/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain}~1limits~1tag/get/responses/200/content/application~1json/examples/Example":{"value":{"limit":20000,"count":1500},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain}~1limits~1tag/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain}~1limits~1tag/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"reason for bad request"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain}~1limits~1tag/get/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Rejected":{"value":{"items":[{"event":"rejected","id":"OMTXD3-sSmKIQa1gSKkYVA","timestamp":1529704976.104692,"log-level":"warn","flags":{"is-test-mode":false},"reject":{"reason":"Sandbox subdomains are for test purposes only. Please add your own domain or add the address to authorized recipients in Account Settings.","description":""},"message":{"headers":{"to":"joan@example.org","message-id":"20180622220256.1.B31A451A2E5422BB@sandbox55887fac92de874df5ae0023b75fd62f1d.mailgun.org","from":"john@sandbox55887fac92de874df5ae0023b75fd62f1d.mailgun.org","subject":"Test Subject"},"attachments":[],"size":867},"tags":[],"user-variables":{}}],"paging":{"next":"https://api.mailgun.net/v3/samples.mailgun.org/events/W3siY...","previous":"https://api.mailgun.net/v3/samples.mailgun.org/events/Lkawm..."}},"key":"Rejected","summary":"Rejected","id":"paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Rejected"},"paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Stored":{"value":{"items":[{"event":"stored","id":"WRVmVc47QYi4DHth_xpRUA","timestamp":1529692198.691758,"log-level":"info","flags":{"is-test-mode":false},"message":{"headers":{"to":"team@example.org","message-id":"20180622182958.1.48906CB188F1A454@exmple.org","from":"sender@example.org","subject":"Test Subject"},"attachments":[],"recipients":["team@example.org"],"size":586},"storage":{"url":"https://se.api.mailgun.net/v3/domains/example.org/messages/eyJwI...","key":"eyJwI..."},"tags":[],"user-variables":{}}],"paging":{"next":"https://api.mailgun.net/v3/samples.mailgun.org/events/W3siY...","previous":"https://api.mailgun.net/v3/samples.mailgun.org/events/Lkawm..."}},"key":"Stored","summary":"Stored","id":"paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Stored"},"paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Complained":{"value":{"items":[{"event":"complained","id":"ncV2XwymRUKbPek_MIM-Gw","timestamp":1377214260.049634,"log-level":"warn","recipient":"foo@example.com","tags":[],"user-variables":{},"flags":{"is-test-mode":false},"message":{"headers":{"to":"foo@example.com","message-id":"20130718032413.263EE2E0926@example.com","from":"John Doe <sender@example.com>","subject":"This is the subject."},"attachments":[],"size":18937}}],"paging":{"next":"https://api.mailgun.net/v3/samples.mailgun.org/events/W3siY...","previous":"https://api.mailgun.net/v3/samples.mailgun.org/events/Lkawm..."}},"key":"Complained","summary":"Complained","id":"paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Complained"},"paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Unsubscribed":{"value":{"items":[{"event":"unsubscribed","id":"W3X4JOhFT-OZidZGKKr9iA","timestamp":1377213791.421473,"log-level":"info","recipient":"recipient@example.com","geolocation":{"country":"US","region":"TX","city":"San Antonio"},"tags":[],"user-variables":{},"ip":"23.23.23.345","client-info":{"client-type":"browser","client-os":"OS X","device-type":"desktop","client-name":"Chrome","user-agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/28.0.1500.95 Safari/537.36"},"message":{"headers":{"message-id":"20130822232216.13966.79700@samples.mailgun.org"}}}],"paging":{"next":"https://api.mailgun.net/v3/samples.mailgun.org/events/W3siY...","previous":"https://api.mailgun.net/v3/samples.mailgun.org/events/Lkawm..."}},"key":"Unsubscribed","summary":"Unsubscribed","id":"paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Unsubscribed"},"paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Clicked":{"value":{"items":[{"event":"clicked","id":"G5zMz2ysS6OxZ2C8xb2Tqg","timestamp":1377075564.094891,"log-level":"info","recipient":"recipient@example.com","geolocation":{"country":"US","region":"TX","city":"Austin"},"tags":[],"url":"http://example.com/signup","recipient-provider":"Gmail","ip":"123.123.123.321","user-variables":{},"client-info":{"client-type":"browser","client-os":"Linux","device-type":"desktop","client-name":"Chromium","user-agent":"Mozilla/5.0 (X11; Linux i686) AppleWebKit/537.36 (KHTML, like Gecko) Ubuntu Chromium/28.0.1500.71 Chrome/28.0.1500.71 Safari/537.36","bot":""},"message":{"headers":{"message-id":"20130821085807.30688.67706@samples.mailgun.org"}}}],"paging":{"next":"https://api.mailgun.net/v3/samples.mailgun.org/events/W3siY...","previous":"https://api.mailgun.net/v3/samples.mailgun.org/events/Lkawm..."}},"key":"Clicked","summary":"Clicked","id":"paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Clicked"},"paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Opened":{"value":{"items":[{"event":"opened","id":"-laxIqj9QWubsjY_3pTq_g","timestamp":1377047343.042277,"log-level":"info","recipient":"recipient@example.com","recipient-provider":"Gmail","geolocation":{"country":"US","region":"Texas","city":"Austin"},"tags":[],"user-variables":{},"ip":"111.111.111.111","client-info":{"client-type":"mobile browser","client-os":"iOS","device-type":"mobile","client-name":"Mobile Safari","user-agent":"Mozilla/5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) AppleWebKit/536.26 (KHTML, like Gecko) Mobile/10B143","bot":""},"message":{"headers":{"message-id":"20130821005614.19826.35976@samples.mailgun.org"}}}],"paging":{"next":"https://api.mailgun.net/v3/samples.mailgun.org/events/W3siY...","previous":"https://api.mailgun.net/v3/samples.mailgun.org/events/Lkawm..."}},"key":"Opened","summary":"Opened","id":"paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Opened"},"paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Failed":{"value":{"items":[{"event":"failed","id":"pl271FzxTTmGRW8Uj3dUWw","timestamp":1529701969.818328,"log-level":"error","severity":"permanent","reason":"suppress-bounce","envelope":{"sender":"john@example.org","transport":"smtp","targets":"joan@example.com"},"flags":{"is-routed":false,"is-authenticated":true,"is-system-test":false,"is-test-mode":false},"delivery-status":{"attempt-no":1,"message":"","code":605,"description":"Not delivering to previously bounced address","session-seconds":0},"message":{"headers":{"to":"joan@example.com","message-id":"20180622211249.1.2A6098970A380E12@example.org","from":"john@example.org","subject":"Test Subject"},"attachments":[],"size":867},"storage":{"url":"https://se.api.mailgun.net/v3/domains/example.org/messages/eyJwI...","key":"eyJwI..."},"recipient":"slava@mailgun.com","recipient-domain":"mailgun.com","recipient-provider":"Gmail","tags":[],"user-variables":{}}],"paging":{"next":"https://api.mailgun.net/v3/samples.mailgun.org/events/W3siY...","previous":"https://api.mailgun.net/v3/samples.mailgun.org/events/Lkawm..."}},"key":"Failed","summary":"Failed","id":"paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Failed"},"paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Delivered":{"value":{"items":[{"event":"delivered","id":"hK7mQVt1QtqRiOfQXta4sw","timestamp":1529692199.626182,"log-level":"info","envelope":{"transport":"smtp","sender":"sender@example.org","sending-ip":"123.123.123.123","targets":"john@example.com"},"flags":{"is-routed":false,"is-authenticated":false,"is-system-test":false,"is-test-mode":false},"delivery-status":{"tls":true,"mx-host":"aspmx.l.example.com","code":250,"description":"","session-seconds":0.4367079734802246,"utf8":true,"attempt-no":1,"message":"OK","certificate-verified":true},"message":{"headers":{"to":"team@example.org","message-id":"20180622182958.1.48906CB188F1A454@exmple.org","from":"sender@exmple.org","subject":"Test Subject"},"attachments":[],"size":586},"storage":{"url":"https://storage-us-west1.api.mailgun.net/v3/domains/...","region":"us-west1","key":"AwABB...","env":"production"},"recipient":"john@example.com","recipient-domain":"example.com","recipient-provider":"Gmail","tags":[],"user-variables":{}}],"paging":{"next":"https://api.mailgun.net/v3/samples.mailgun.org/events/W3siY...","previous":"https://api.mailgun.net/v3/samples.mailgun.org/events/Lkawm..."}},"key":"Delivered","summary":"Delivered","id":"paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Delivered"},"paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Accepted":{"value":{"items":[{"event":"accepted","id":"jxVuhYlhReaK3QsggHfFRA","timestamp":1529692198.641821,"log-level":"info","method":"smtp","envelope":{"targets":"team@example.org","transport":"smtp","sender":"sender@example.org"},"flags":{"is-authenticated":false},"message":{"headers":{"to":"team@example.org","message-id":"20180622182958.1.48906CB188F1A454@exmple.org","from":"sender@example.org","subject":"Test Subject"},"attachments":[],"recipients":["team@example.org"],"size":586},"storage":{"url":"https://se.api.mailgun.net/v3/domains/example.org/messages/eyJwI...","key":"eyJwI..."},"recipient":"team@example.org","recipient-domain":"example.org","tags":[],"user-variables":{}}],"paging":{"next":"https://api.mailgun.net/v3/samples.mailgun.org/events/W3siY...","previous":"https://api.mailgun.net/v3/samples.mailgun.org/events/Lkawm..."}},"key":"Accepted","summary":"Accepted","id":"paths/~1v3~1{domain_name}~1events/get/responses/200/content/application~1json/examples/Accepted"},"paths/~1v1~1thresholds~1alerts~1send/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"id":"915ff385-0a9a-4087-86d5-6727ea7d9b49","parent_account_id":"12345","subaccount_id":"67890","name":"hard bounce rate","created_at":"2026-02-01T10:30:00Z","updated_at":"2026-02-03T14:15:00Z","last_checked":"2026-02-04T16:00:00Z","alert_channels":["email","webhook","slack"],"metric":"hard_bounce_rate","comparator":"<","limit":".99","dimension":"subaccount","period":"1h"},{"id":"734ff385-0a9a-4087-86d5-6727ea7d9c34","parent_account_id":"12345","subaccount_id":"67890","name":"complaint rate","created_at":"2026-02-01T10:30:00Z","updated_at":"2026-02-03T14:15:00Z","last_checked":"2026-02-01T10:30:00Z","alert_channels":["email"],"metric":"complained_rate","comparator":">","limit":".01","dimension":"subaccount","period":"1h"}],"total":2},"key":"Example","summary":"Example","id":"paths/~1v1~1thresholds~1alerts~1send/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1thresholds~1alerts~1send/post/requestBody/content/application~1json/examples/Example":{"value":{"name":"hard bounce rate","metric":"hard_bounce_rate","comparator":"<","limit":".99","dimension":"subaccount","alert_channels":["email","webhook","slack"],"period":"1h"},"key":"Example","summary":"Example","id":"paths/~1v1~1thresholds~1alerts~1send/post/requestBody/content/application~1json/examples/Example"},"paths/~1v1~1thresholds~1alerts~1send/post/responses/200/content/application~1json/examples/Example":{"value":{"id":"915ff385-0a9a-4087-86d5-6727ea7d9b49","parent_account_id":"12345","subaccount_id":"67890","name":"delivery rate","created_at":"2026-02-01T10:30:00Z","updated_at":"2026-02-01T10:30:00Z","last_checked":"2026-02-01T10:30:00Z","alert_channels":["email","webhook","slack"],"metric":"delivered_rate","comparator":"<","limit":".99","dimension":"subaccount","period":"1h"},"key":"Example","summary":"Example","id":"paths/~1v1~1thresholds~1alerts~1send/post/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1thresholds~1alerts~1send~1{name}/get/responses/200/content/application~1json/examples/Example":{"value":{"id":"915ff385-0a9a-4087-86d5-6727ea7d9b49","parent_account_id":"12345","subaccount_id":"67890","name":"delivery rate","created_at":"2026-02-01T10:30:00Z","updated_at":"2026-02-03T14:15:00Z","last_checked":"2026-02-04T16:00:00Z","alert_channels":["email","webhook","slack"],"metric":"delivered_rate","comparator":"<","limit":".99","dimension":"subaccount","period":"1h"},"key":"Example","summary":"Example","id":"paths/~1v1~1thresholds~1alerts~1send~1{name}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1thresholds~1alerts~1send~1{name}/put/requestBody/content/application~1json/examples/Example":{"value":{"name":"hard bounce rate","metric":"hard_bounce_rate","comparator":"<","limit":".98","dimension":"subaccount","alert_channels":["email","webhook","slack"],"period":"1h"},"key":"Example","summary":"Example","id":"paths/~1v1~1thresholds~1alerts~1send~1{name}/put/requestBody/content/application~1json/examples/Example"},"paths/~1v1~1thresholds~1hits/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"id":"915ff385-0a9a-4087-86d5-6727ea7d9b49","name":"hard bounce rate","created_at":"2026-02-01T10:30:00Z","updated_at":"2026-02-03T14:15:00Z","triggered":true,"expires_at":"0001-01-01T00:00:00Z","latest_value":"10","metric":"hard_bounce_rate","comparator":"<","limit":"2100","parent_account_id":"12345","subaccount_id":"67890","dimension":"subaccount"},{"id":"734ff385-0a9a-4087-86d5-6727ea7d9c34","name":"complained rate","created_at":"2026-02-01T10:30:00Z","updated_at":"2026-02-03T14:15:00Z","triggered":true,"expires_at":"0001-01-01T00:00:00Z","latest_value":"7","metric":"complained_rate","comparator":">","limit":"1000","parent_account_id":"12345","subaccount_id":"67890","dimension":"subaccount"}],"total":2},"key":"Example","summary":"Example","id":"paths/~1v1~1thresholds~1hits/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1events/get/responses/200/content/application~1json/examples/Example":{"value":{"events":["ip_listed","ip_delisted"]},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1events/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1settings~1events/post/requestBody/content/application~1json/examples/Example":{"value":{"event_type":"ip_listed","channel":"webhook","settings":{"url":"https://yourwebhookurl.com"}},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1settings~1events/post/requestBody/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1settings~1events/post/responses/200/content/application~1json/examples/Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","event_type":"ip_listed","channel":"webhook","settings":{"url":"https://yourwebhookurl.com"}},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1settings~1events/post/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1settings~1events~1{id}/put/requestBody/content/application~1json/examples/Example":{"value":{"event_type":"ip_delisted","channel":"email","settings":{"emails":["recipient-a@example.com","recipient-b@example.com"]}},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1settings~1events~1{id}/put/requestBody/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1settings~1events~1{id}/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"settings updated"},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1settings~1events~1{id}/put/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1settings~1events~1{id}/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"settings deleted"},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1settings~1events~1{id}/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1settings/get/responses/200/content/application~1json/examples/Example":{"value":{"events":[{"id":"00000000-0000-0000-0000-000000000000","event_type":"ip_listed","channel":"webhook","settings":{"url":"https://example.com/delisted_hook"}},{"id":"00000000-0000-0000-0000-000000000000","event_type":"ip_delisted","channel":"webhook","settings":{"url":"https://yourwebhookurl.com"},"disabled_at":"2006-01-02T22:04:05Z"},{"id":"00000000-0000-0000-0000-000000000000","event_type":"ip_delisted","channel":"email","settings":{"emails":["recipient-1@example.com","recipient-2@example.com"]}}],"webhooks":{},"slack":{}},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1settings/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1webhooks~1test/post/requestBody/content/application~1json/examples/Example":{"value":{"event_type":"some-event","url":"https://some-webhook-url.com/webhook"},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1webhooks~1test/post/requestBody/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1email~1test/post/requestBody/content/application~1json/examples/Example":{"value":{"event_type":"some-event","emails":["email1@example.com","email2@example.com"]},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1email~1test/post/requestBody/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1slack~1test/post/requestBody/content/application~1json/examples/Example":{"value":{"event_type":"some-event","channel_ids":["C0123","C0456"]},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1slack~1test/post/requestBody/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/200/content/application~1json/examples/Example":{"value":{"id":"C012AB3CD","name":"general"},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/401/content/application~1json/examples/Example":{"value":{"message":"token should have 'xoxb-' prefix"},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/401/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/403/content/application~1json/examples/Example":{"value":{"message":"missing_scope: please reconnect the Slack App"},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/403/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/404/content/application~1json/examples/Example":{"value":{"message":"no settings"},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/404/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1slack~1channels/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"id":"C012AB3CD","name":"general"}],"paging":{"first":"https://api.mailgun.net/v1/alerts/slack/channels?page=foo","next":"https://api.mailgun.net/v1/alerts/slack/channels?page=bar"}},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1slack~1channels/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1slack~1channels/get/responses/401/content/application~1json/examples/Example":{"value":{"message":"token should have 'xoxb-' prefix"},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1slack~1channels/get/responses/401/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1slack~1channels/get/responses/403/content/application~1json/examples/Example":{"value":{"message":"missing_scope: please reconnect the Slack App"},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1slack~1channels/get/responses/403/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1slack~1channels/get/responses/404/content/application~1json/examples/Example":{"value":{"message":"no settings"},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1slack~1channels/get/responses/404/content/application~1json/examples/Example"},"paths/~1v1~1thresholds~1limits/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"id":"915ff385-0a9a-4087-86d5-6727ea7d9b49","parent_account_id":"12345","subaccount_id":"67890","name":"email preview","created_at":"2026-02-01T10:30:00Z","updated_at":"2026-02-03T14:15:00Z","last_checked":"2026-02-04T16:00:00Z","metric":"email_preview_success_count","comparator":">=","limit":"2100","dimension":"subaccount","period":"1M"},{"id":"734ff385-0a9a-4087-86d5-6727ea7d9c34","parent_account_id":"12345","subaccount_id":"67890","name":"email preview strict","created_at":"2026-02-01T10:30:00Z","updated_at":"2026-02-03T14:15:00Z","last_checked":"2026-02-04T16:00:00Z","metric":"email_preview_success_count","comparator":">=","limit":"1000","dimension":"subaccount","period":"1M"}],"total":2},"key":"Example","summary":"Example","id":"paths/~1v1~1thresholds~1limits/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1thresholds~1limits/post/requestBody/content/application~1json/examples/Example":{"value":{"name":"email preview","metric":"email_preview_success_count","comparator":">=","limit":"2100","dimension":"subaccount","period":"1M"},"key":"Example","summary":"Example","id":"paths/~1v1~1thresholds~1limits/post/requestBody/content/application~1json/examples/Example"},"paths/~1v1~1thresholds~1limits/post/responses/200/content/application~1json/examples/Example":{"value":{"id":"915ff385-0a9a-4087-86d5-6727ea7d9b49","parent_account_id":"12345","subaccount_id":"67890","name":"email preview","created_at":"2026-02-01T10:30:00Z","updated_at":"0001-01-01T00:00:00Z","last_checked":"0001-01-01T00:00:00Z","metric":"email_preview_success_count","comparator":">=","limit":"2100","dimension":"subaccount","period":"1M"},"key":"Example","summary":"Example","id":"paths/~1v1~1thresholds~1limits/post/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1thresholds~1limits~1{name}/get/responses/200/content/application~1json/examples/Example":{"value":{"id":"915ff385-0a9a-4087-86d5-6727ea7d9b49","parent_account_id":"12345","subaccount_id":"67890","name":"email preview","created_at":"2026-02-01T10:30:00Z","updated_at":"2026-02-03T14:15:00Z","last_checked":"2026-02-04T16:00:00Z","metric":"email_preview_success_count","comparator":">=","limit":"2100","dimension":"subaccount","period":"1M"},"key":"Example","summary":"Example","id":"paths/~1v1~1thresholds~1limits~1{name}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1thresholds~1limits~1{name}/put/requestBody/content/application~1json/examples/Example":{"value":{"name":"email preview","metric":"email_preview_success_count","comparator":">=","limit":"2100","dimension":"subaccount","period":"1M"},"key":"Example","summary":"Example","id":"paths/~1v1~1thresholds~1limits~1{name}/put/requestBody/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1unsubscribes~1import/post/responses/202/content/application~1json/examples/Example":{"value":{"message":"file uploaded successfully for processing. standby..."},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1unsubscribes~1import/post/responses/202/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1unsubscribes~1import/post/responses/400/content/application~1json/examples/Example":{"value":{"message":"while reading csv header"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1unsubscribes~1import/post/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1unsubscribes~1import/post/responses/500/content/application~1json/examples/Example":{"value":{"message":"Internal Server Error"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1unsubscribes~1import/post/responses/500/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1unsubscribes~1{address}/get/responses/200/content/application~1json/examples/Example":{"value":{"address":"alice@example.com","tags":["some tag"],"created_at":"Thu, 11 Dec 2025 01:49:40 UTC"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1unsubscribes~1{address}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1unsubscribes~1{address}/get/responses/404/content/application~1json/examples/Example":{"value":{"message":"Address not found in unsubscribers table"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1unsubscribes~1{address}/get/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1unsubscribes~1{address}/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"Unsubscribe event has been removed","address":"foo@bar.com"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1unsubscribes~1{address}/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1unsubscribes~1{address}/delete/responses/404/content/application~1json/examples/Example":{"value":{"message":"Unsubscribe event for this tag does not exist"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1unsubscribes~1{address}/delete/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1unsubscribes/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"address":"alice@example.com","tags":["some tag"],"created_at":"Thu, 11 Dec 2025 01:49:40 UTC"}],"paging":{"previous":"<previous page url>","first":"<first page url>","next":"<next page url>","last":"<last page url>"}},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1unsubscribes/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1unsubscribes/post/requestBody/content/application~1json/examples/Example":{"value":[{"address":"alice@example.com","tags":["some tag"],"createdat":"Thu, 11 Dec 2025 01:49:40 UTC"},{"address":"bob@example.com","tags":["*"],"createdat":"Mon, 01 Jan 0001 00:00:00 UTC"},{"address":"carol@example.com","tags":[],"createdat":"Mon, 01 Jan 0001 00:00:00 UTC"}],"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1unsubscribes/post/requestBody/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1unsubscribes/post/responses/200/content/application~1json/examples/Example":{"value":{"message":"4 addresses have been added to the unsubscribes table"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1unsubscribes/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1unsubscribes/post/responses/400/content/application~1json/examples/Example":{"value":{"message":"Batch size should be less than 1000"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1unsubscribes/post/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1unsubscribes/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"Unsubscribe addresses for this domain have been removed"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1unsubscribes/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1complaints~1import/post/responses/202/content/application~1json/examples/Example":{"value":{"message":"ffile uploaded successfully for processing. standby..."},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1complaints~1import/post/responses/202/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1complaints~1import/post/responses/400/content/application~1json/examples/Example":{"value":{"message":"while reading csv header"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1complaints~1import/post/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1complaints~1import/post/responses/500/content/application~1json/examples/Example":{"value":{"message":"Internal Server Error"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1complaints~1import/post/responses/500/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1complaints~1{address}/get/responses/200/content/application~1json/examples/Example":{"value":{"address":"alice@example.com","created_at":"Thu, 11 Dec 2025 01:49:40 UTC"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1complaints~1{address}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1complaints~1{address}/get/responses/404/content/application~1json/examples/Example":{"value":{"message":"No spam complaints found for this address"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1complaints~1{address}/get/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1complaints~1{address}/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"Complaint addresses for this domain have been removed","address":"foo@bar.com"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1complaints~1{address}/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1complaints~1{address}/delete/responses/404/content/application~1json/examples/Example":{"value":{"message":"No spam complaints found for this address"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1complaints~1{address}/delete/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1complaints/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"address":"alice@example.com","created_at":"Thu, 11 Dec 2025 01:49:40 UTC"}],"paging":{"previous":"<previous page url>","first":"<first page url>","next":"<next page url>","last":"<last page url>"}},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1complaints/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1complaints/post/requestBody/content/application~1json/examples/Example":{"value":[{"address":"alice@example.com","createdat":"Thu, 11 Dec 2025 01:49:40 UTC"},{"address":"bob@example.com","createdat":"Mon, 01 Jan 0001 00:00:00 UTC"}],"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1complaints/post/requestBody/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1complaints/post/responses/200/content/application~1json/examples/Example":{"value":{"message":"2 complaint addresses have been added to the complaints table"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1complaints/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1complaints/post/responses/400/content/application~1json/examples/Example":{"value":{"message":"Batch size should be less than 1000"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1complaints/post/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1complaints/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"Complaint addresses for this domain have been removed"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1complaints/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1bounces~1import/post/responses/202/content/application~1json/examples/Example":{"value":{"message":"file uploaded successfully for processing. standby..."},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1bounces~1import/post/responses/202/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1bounces~1import/post/responses/400/content/application~1json/examples/Example":{"value":{"message":"Internal Server Error"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1bounces~1import/post/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1bounces~1import/post/responses/500/content/application~1json/examples/Example":{"value":{"message":"while reading csv header"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1bounces~1import/post/responses/500/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1bounces~1{address}/get/responses/200/content/application~1json/examples/Example":{"value":{"address":"foo@bar.com","code":"550","error":"No such mailbox","created_at":"Thu, 11 Dec 2025 01:49:40 UTC"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1bounces~1{address}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1bounces~1{address}/get/responses/404/content/application~1json/examples/Example":{"value":{"message":"Address not found in bounces table"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1bounces~1{address}/get/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1bounces~1{address}/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"Bounced addresses for this domain have been removed","address":"foo@bar.com"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1bounces~1{address}/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1bounces~1{address}/delete/responses/404/content/application~1json/examples/Example":{"value":{"message":"Address not found in bounces table"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1bounces~1{address}/delete/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1bounces/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"address":"foo@bar.com","code":"550","error":"No such mailbox","created_at":"Thu, 11 Dec 2025 01:49:40 UTC"}],"paging":{"previous":"<previous page url>","first":"<first page url>","next":"<next page url>","last":"<last page url>"}},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1bounces/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1bounces/post/requestBody/content/application~1json/examples/Example":{"value":[{"address":"alice@example.com","code":"550","error":"Bounced","createdat":"Thu, 11 Dec 2025 01:49:40 UTC","messagehash":""},{"address":"bob@example.com","code":"550","error":"Bounced","createdat":"Mon, 01 Jan 0001 00:00:00 UTC","messagehash":""},{"address":"carol@example.com","code":"550","error":"","createdat":"Mon, 01 Jan 0001 00:00:00 UTC","messagehash":""},{"address":"dan@example.com","code":"","error":"","createdat":"Mon, 01 Jan 0001 00:00:00 UTC","messagehash":""}],"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1bounces/post/requestBody/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1bounces/post/responses/200/content/application~1json/examples/Example":{"value":{"message":"4 addresses have been added to the bounces table"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1bounces/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1bounces/post/responses/400/content/application~1json/examples/Example":{"value":{"message":"Batch size should be less than 1000"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1bounces/post/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1bounces/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"Bounced addresses for this domain have been removed"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1bounces/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1whitelists~1import/post/responses/202/content/application~1json/examples/Example":{"value":{"message":"file uploaded successfully for processing. standby..."},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1whitelists~1import/post/responses/202/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1whitelists~1import/post/responses/400/content/application~1json/examples/Example":{"value":{"message":"while reading csv header"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1whitelists~1import/post/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1whitelists~1import/post/responses/500/content/application~1json/examples/Example":{"value":{"message":"Internal Server Error"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1whitelists~1import/post/responses/500/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1whitelists~1{value}/get/responses/200/content/application~1json/examples/Example":{"value":{"type":"domain","value":"alice@example.com","createdAt":"Thu, 11 Dec 2025 01:49:40 UTC","reason":"why the record was created"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1whitelists~1{value}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1whitelists~1{value}/get/responses/404/content/application~1json/examples/Example":{"value":{"message":"Address/Domain not found in allowlist table"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1whitelists~1{value}/get/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1whitelists~1{value}/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"Allowlist address/domain has been removed","value":"example.com"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1whitelists~1{value}/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1whitelists~1{value}/delete/responses/404/content/application~1json/examples/Example":{"value":{"message":"Address/Domain not found in allowlist table"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1whitelists~1{value}/delete/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1whitelists/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"type":"domain","value":"alice@example.com","createdAt":"Thu, 11 Dec 2025 01:49:40 UTC","reason":"why the record was created"}],"paging":{"previous":"<previous page url>","first":"<first page url>","next":"<next page url>","last":"<last page url>"}},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1whitelists/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1whitelists/post/responses/200/content/application~1json/examples/Example":{"value":{"message":"Address/Domain has been added to the allowlists table","type":"domain","value":"example.com"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1whitelists/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1whitelists/post/responses/400/content/application~1json/examples/Example":{"value":{"message":"Missing mandatory parameter: address/domain"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1whitelists/post/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1whitelists/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"Allowlist addresses/domains for this domain have been removed"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1whitelists/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1routes/post/requestBody/content/application~1x-www-form-urlencoded/examples/Example":{"value":{"priority":0,"description":"it's a new route","expression":"match_recipient('.*@gmail.com')","action":["forward(\"http://myhost.com/messages/\")","stop()"]},"key":"Example","summary":"Example","id":"paths/~1v3~1routes/post/requestBody/content/application~1x-www-form-urlencoded/examples/Example"},"paths/~1v3~1routes/post/responses/200/content/application~1json/examples/Example":{"value":{"message":"Route has been created","route":{"id":"4f3bad2335335426750048c6","priority":0,"description":"it's a new route","expression":"match_recipient('.*@gmail.com')","actions":["forward(\"http://myhost.com/messages/\")"],"created_at":"Wed, 15 Feb 2012 13:03:31 GMT"}},"key":"Example","summary":"Example","id":"paths/~1v3~1routes/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1routes/get/responses/200/content/application~1json/examples/Example":{"value":{"total_count":1,"items":[{"id":"4f3bad2335335426750048c6","priority":0,"description":"Sample route","expression":"match_recipient(\".*@samples.mailgun.org\")","actions":["forward(\"http://myhost.com/messages/\")","stop()"],"created_at":"Wed, 15 Feb 2012 13:03:31 GMT"}]},"key":"Example","summary":"Example","id":"paths/~1v3~1routes/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1routes/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"The 'limit' parameter can't be larger than 1000"},"key":"Example","summary":"Example","id":"paths/~1v3~1routes/get/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1routes~1{id}/get/responses/200/content/application~1json/examples/Example":{"value":{"route":{"id":"4f3bad2335335426750048c6","priority":0,"description":"Sample route","expression":"match_recipient(\".*@samples.mailgun.org\")","actions":["forward(\"http://myhost.com/messages/\")","stop()"],"created_at":"Wed, 15 Feb 2012 13:03:31 GMT"}},"key":"Example","summary":"Example","id":"paths/~1v3~1routes~1{id}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1routes~1{id}/get/responses/404/content/application~1json/examples/Example":{"value":{"message":"string"},"key":"Example","summary":"Example","id":"paths/~1v3~1routes~1{id}/get/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1routes~1{id}/put/requestBody/content/application~1x-www-form-urlencoded/examples/Example":{"value":{"priority":0,"description":"Sample route","expression":"match_recipient(\".*@samples.mailgun.org\")","action":["forward(\"http://myhost.com/messages/\")","stop()"]},"key":"Example","summary":"Example","id":"paths/~1v3~1routes~1{id}/put/requestBody/content/application~1x-www-form-urlencoded/examples/Example"},"paths/~1v3~1routes~1{id}/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"Route has been updated","route":{"id":"4f3bad2335335426750048c6","priority":0,"description":"Sample route","expression":"match_recipient(\".*@samples.mailgun.org\")","actions":["forward(\"http://myhost.com/messages/\")","stop()"],"created_at":"Wed, 15 Feb 2012 13:03:31 GMT"}},"key":"Example","summary":"Example","id":"paths/~1v3~1routes~1{id}/put/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1routes~1{id}/put/responses/404/content/application~1json/examples/Example":{"value":{"message":"Route not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1routes~1{id}/put/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1routes~1{id}/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"Route has been deleted","id":"4f3bad2335335426750048c6"},"key":"Example","summary":"Example","id":"paths/~1v3~1routes~1{id}/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1routes~1{id}/delete/responses/404/content/application~1json/examples/Example":{"value":{"message":"Route not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1routes~1{id}/delete/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1routes~1match/get/responses/200/content/application~1json/examples/Example":{"value":{"route":{"id":"4f3bad2335335426750048c6","priority":0,"description":"Sample route","expression":"match_recipient(\".*@samples.mailgun.org\")","actions":["forward(\"http://myhost.com/messages/\")","stop()"],"created_at":"Wed, 15 Feb 2012 13:03:31 GMT"}},"key":"Example","summary":"Example","id":"paths/~1v3~1routes~1match/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1routes~1match/get/responses/404/content/application~1json/examples/Example":{"value":{"message":"Route not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1routes~1match/get/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1forwards~1{id}/get/responses/200/content/application~1json/examples/Example":{"value":{"id":"60d9431e582ecdc84b886284","account_id":"646634cc58ea2b8fe43e0000","domain_name":"my-domain.com","domain_id":"642134nn58ea2b8fe43e0000","match":"wild*card@example.com","forward":{"urls":["https://example.com/webhook"],"recipients":["destination@gmail.com"],"store":"https://my-store-url.com/store"},"created_at":"Mon, 28 Jun 2021 03:33:50 UTC","updated_at":"Mon, 28 Jun 2021 03:33:50 UTC"},"key":"Example","summary":"Example","id":"paths/~1v3~1forwards~1{id}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1forwards~1{id}/put/responses/200/content/application~1json/examples/Example":{"value":{"id":"60d9431e582ecdc84b886284","account_id":"646634cc58ea2b8fe43e0000","domain_name":"my-domain.com","domain_id":"642134nn58ea2b8fe43e0000","match":"wild*card@example.com","forward":{"urls":["https://example.com/webhook"],"recipients":["destination@gmail.com"],"store":"https://my-store-url.com/store"},"created_at":"Mon, 28 Jun 2021 03:33:50 UTC","updated_at":"Mon, 28 Jun 2021 03:33:50 UTC"},"key":"Example","summary":"Example","id":"paths/~1v3~1forwards~1{id}/put/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1forwards~1{id}/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"forward rule '1234' deleted"},"key":"Example","summary":"Example","id":"paths/~1v3~1forwards~1{id}/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1forwards/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"id":"60d9431e582ecdc84b886284","account_id":"646634cc58ea2b8fe43e0000","domain_name":"my-domain.com","domain_id":"642134nn58ea2b8fe43e0000","match":"wild*card@example.com","forward":{"urls":["https://example.com/webhook"],"recipients":["destination@gmail.com"],"store":"https://my-store-url.com/store"},"created_at":"Mon, 28 Jun 2021 03:33:50 UTC","updated_at":"Mon, 28 Jun 2021 03:33:50 UTC"}],"paging":{"previous":"https://api.mailgun.net/page=0","first":"https://api.mailgun.net/page=0","next":"https://api.mailgun.net/page=1","last":"https://api.mailgun.net/page=22"}},"key":"Example","summary":"Example","id":"paths/~1v3~1forwards/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1forwards/post/responses/200/content/application~1json/examples/Example":{"value":{"id":"60d9431e582ecdc84b886284","account_id":"646634cc58ea2b8fe43e0000","domain_name":"my-domain.com","domain_id":"642134nn58ea2b8fe43e0000","match":"wild*card@example.com","forward":{"urls":["https://example.com/webhook"],"recipients":["destination@gmail.com"],"store":"https://my-store-url.com/store"},"created_at":"Mon, 28 Jun 2021 03:33:50 UTC","updated_at":"Mon, 28 Jun 2021 03:33:50 UTC"},"key":"Example","summary":"Example","id":"paths/~1v3~1forwards/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1lists/post/requestBody/content/multipart~1form-data/examples/Example":{"value":{"address":"developers@mailgun.net","name":"Developers","description":"Describe the mailing list","access_level":"readonly","reply_preference":"list"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists/post/requestBody/content/multipart~1form-data/examples/Example"},"paths/~1v3~1lists/post/responses/201/content/application~1json/examples/Example":{"value":{"list":{"address":"developers@mailgun.net","name":"Developers","description":"Describe the mailing list","access_level":"readonly","reply_preference":"list","created_at":"Tue, 09 Aug 2011 20:50:27 -0000","members_count":2},"message":"Mailing list has been created"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists/post/responses/201/content/application~1json/examples/Example"},"paths/~1v3~1lists/post/responses/400/content/application~1json/examples/Example 1":{"value":{"message":"Invalid access level 'fake_access_level'. It can be any of: 'readonly', 'members', 'everyone'."},"key":"Example 1","summary":"Example 1","id":"paths/~1v3~1lists/post/responses/400/content/application~1json/examples/Example 1"},"paths/~1v3~1lists/post/responses/400/content/application~1json/examples/Example 2":{"value":{"message":"Invalid reply preference 'wrong_preference'. It can be any of: 'sender', 'list'"},"key":"Example 2","summary":"Example 2","id":"paths/~1v3~1lists/post/responses/400/content/application~1json/examples/Example 2"},"paths/~1v3~1lists/post/responses/429/content/application~1json/examples/Example":{"value":{"message":"Too Many Requests"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists/post/responses/429/content/application~1json/examples/Example"},"paths/~1v3~1lists/get/responses/200/content/application~1json/examples/Example":{"value":{"total_count":1,"items":[{"address":"developers@mailgun.net","name":"Developers","description":"Describe the mailing list","access_level":"readonly","reply_preference":"list","created_at":"Tue, 09 Aug 2011 20:50:27 -0000","members_count":2}]},"key":"Example","summary":"Example","id":"paths/~1v3~1lists/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1lists/get/responses/429/content/application~1json/examples/Example":{"value":{"message":"Too Many Requests"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists/get/responses/429/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}~1members/get/responses/200/content/application~1json/examples/Example":{"value":{"total_count":1,"items":[{"address":"alice@example.com","name":"Alice","vars":{"gender":"female","age":27},"subscribed":true}]},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}~1members/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}~1members/get/responses/429/content/application~1json/examples/Example":{"value":{"message":"Too Many Requests"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}~1members/get/responses/429/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}~1members/post/requestBody/content/multipart~1form-data/examples/Example":{"value":{"address":"alice@example.com","name":"Alice","vars":{"gender":"female","age":27},"subscribed":true,"upsert":true},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}~1members/post/requestBody/content/multipart~1form-data/examples/Example"},"paths/~1v3~1lists~1{list_address}~1members/post/responses/200/content/application~1json/examples/Example":{"value":{"member":{"address":"alice@example.com","name":"Alice","vars":{"gender":"female","age":27},"subscribed":true},"message":"Mailing list member has been created"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}~1members/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}~1members/post/responses/400/content/application~1json/examples/Example":{"value":{"message":"Address already exists 'alice@example.com'"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}~1members/post/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}~1members/post/responses/429/content/application~1json/examples/Example":{"value":{"message":"Too Many Requests"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}~1members/post/responses/429/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}~1members.json/post/responses/200/content/application~1json/examples/Async update":{"value":{"list":{"address":"developers@mailgun.net","name":"Developers","description":"Describe the mailing list","access_level":"readonly","reply_preference":"list","created_at":"Tue, 09 Aug 2011 20:50:27 -0000","members_count":2},"task-id":"4321","message":"Mailing list upload started in background"},"key":"Async update","summary":"Async update","id":"paths/~1v3~1lists~1{list_address}~1members.json/post/responses/200/content/application~1json/examples/Async update"},"paths/~1v3~1lists~1{list_address}~1members.json/post/responses/404/content/application~1json/examples/Example":{"value":{"message":"Mailing list 'devs@mg.net' not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}~1members.json/post/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}~1members.json/post/responses/429/content/application~1json/examples/Example":{"value":{"message":"Too Many Requests"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}~1members.json/post/responses/429/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}~1members.csv/post/requestBody/content/multipart~1form-data/examples/Example":{"value":{"upsert":true,"members":"absolute/path/to/file/members.csv"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}~1members.csv/post/requestBody/content/multipart~1form-data/examples/Example"},"paths/~1v3~1lists~1{list_address}~1members.csv/post/responses/200/content/application~1json/examples/Example":{"value":{"list":{"address":"developers@mailgun.net","name":"Developers","description":"Describe the mailing list","access_level":"readonly","reply_preference":"list","created_at":"Tue, 09 Aug 2011 20:50:27 -0000","members_count":2},"task-id":"4321","message":"Mailing list upload started in background"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}~1members.csv/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}~1members.csv/post/responses/400/content/application~1json/examples/Example":{"value":{"message":"CSV file is too big, max allowed size is 5 MB"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}~1members.csv/post/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}~1members.csv/post/responses/404/content/application~1json/examples/Example":{"value":{"message":"Mailing list 'devs@mg.net' not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}~1members.csv/post/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}~1members.csv/post/responses/429/content/application~1json/examples/Example":{"value":{"message":"Too Many Requests"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}~1members.csv/post/responses/429/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}~1members~1{member_address}/get/responses/200/content/application~1json/examples/Example":{"value":{"address":"alice@example.com","name":"Alice","vars":{"gender":"female","age":27},"subscribed":true},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}~1members~1{member_address}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}~1members~1{member_address}/get/responses/429/content/application~1json/examples/Example":{"value":{"message":"Too Many Requests"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}~1members~1{member_address}/get/responses/429/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}~1members~1{member_address}/put/requestBody/content/multipart~1form-data/examples/Example":{"value":{"address":"alice@example.com","name":"Alice","vars":{"gender":"female","age":27},"subscribed":true},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}~1members~1{member_address}/put/requestBody/content/multipart~1form-data/examples/Example"},"paths/~1v3~1lists~1{list_address}~1members~1{member_address}/put/responses/200/content/application~1json/examples/Example":{"value":{"member":{"address":"alice@example.com","name":"Alice","vars":{"gender":"female","age":27},"subscribed":true},"message":"Mailing list member has been updated"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}~1members~1{member_address}/put/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}~1members~1{member_address}/put/responses/429/content/application~1json/examples/Example":{"value":{"message":"Too Many Requests"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}~1members~1{member_address}/put/responses/429/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}~1members~1{member_address}/delete/responses/200/content/application~1json/examples/Example":{"value":{"member":{"address":"alice@example.com"},"message":"Mailing list member has been deleted"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}~1members~1{member_address}/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}~1members~1{member_address}/delete/responses/404/content/application~1json/examples/Example":{"value":{"message":"Member dev@example.com of mailing list alice@example.com not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}~1members~1{member_address}/delete/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}~1members~1{member_address}/delete/responses/429/content/application~1json/examples/Example":{"value":{"message":"Too Many Requests"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}~1members~1{member_address}/delete/responses/429/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}/put/requestBody/content/multipart~1form-data/examples/Example":{"value":{"address":"developers@mailgun.net","name":"Developers","description":"Describe the mailing list","access_level":"readonly","reply_preference":"list","list_id":"123"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}/put/requestBody/content/multipart~1form-data/examples/Example"},"paths/~1v3~1lists~1{list_address}/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"Mailing list has been updated","list":{"address":"developers@mailgun.net","name":"Developers","description":"Describe the mailing list","access_level":"readonly","reply_preference":"list","created_at":"Tue, 09 Aug 2011 20:50:27 -0000","members_count":2}},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}/put/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}/put/responses/404/content/application~1json/examples/Example":{"value":{"message":"Mailing list developers@mailgun.net not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}/put/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}/put/responses/429/content/application~1json/examples/Example":{"value":{"message":"Too Many Requests"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}/put/responses/429/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}/delete/responses/200/content/application~1json/examples/Example":{"value":{"address":"developers@mailgun.net","message":"Mailing list has been removed"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}/delete/responses/404/content/application~1json/examples/Example":{"value":{"message":"Mailing list developers@mailgun.net not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}/delete/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}/delete/responses/429/content/application~1json/examples/Example":{"value":{"message":"Too Many Requests"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}/delete/responses/429/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}/get/responses/200/content/application~1json/examples/Example":{"value":{"list":{"address":"developers@mailgun.net","name":"Developers","description":"Describe the mailing list","access_level":"readonly","reply_preference":"list","created_at":"Tue, 09 Aug 2011 20:50:27 -0000","members_count":2}},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}/get/responses/404/content/application~1json/examples/Example":{"value":{"message":"Mailing list developers@mailgun.net not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}/get/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}/get/responses/429/content/application~1json/examples/Example":{"value":{"message":"Too Many Requests"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}/get/responses/429/content/application~1json/examples/Example"},"paths/~1v3~1lists~1pages/get/responses/200/content/application~1json/examples/Example":{"value":{"paging":{"first":"https://url_to_first_page","last":"https://url_to_last_page","next":"https://url_to_next_page","previous":"https://url_to_previous_page"},"items":[{"access_level":"everyone","address":"dev@samples.mailgun.org","created_at":"Tue, 06 Mar 2012 05:44:45 GMT","description":"Mailgun developers list","members_count":1,"name":""},{"access_level":"readonly","address":"bar@example.com","created_at":"Wed, 06 Mar 2013 11:39:51 GMT","description":"","members_count":2,"name":""}]},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1pages/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1lists~1pages/get/responses/429/content/application~1json/examples/Example":{"value":{"message":"Too Many Requests"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1pages/get/responses/429/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}~1members~1pages/get/responses/200/content/application~1json/examples/Example":{"value":{"paging":{"first":"https://url_to_first_page","last":"https://url_to_last_page","next":"https://url_to_next_page","previous":"https://url_to_previous_page"},"items":[{"access_level":"everyone","address":"dev@samples.mailgun.org","created_at":"Tue, 06 Mar 2012 05:44:45 GMT","description":"Mailgun developers list","members_count":1,"name":""},{"access_level":"readonly","address":"bar@example.com","created_at":"Wed, 06 Mar 2013 11:39:51 GMT","description":"","members_count":2,"name":""}]},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}~1members~1pages/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_address}~1members~1pages/get/responses/429/content/application~1json/examples/Example":{"value":{"message":"Too Many Requests"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_address}~1members~1pages/get/responses/429/content/application~1json/examples/Example"},"paths/~1v4~1templates/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"name":"template.0","description":"Description for template 0","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","id":"48d63154-8c8f-4104-ab14-687d01dbf296"},{"name":"template.1","description":"Description for template 1","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","id":"8d9c0f0d-7bf7-43a4-92a9-791a854d12a4"}],"paging":{"previous":"https://api.mailgun.net/v4/templates?page=previous&p=template.0&limit=10","first":"https://api.mailgun.net/v4/templates?limit=10","next":"https://api.mailgun.net/v4/templates?page=next&p=template.2&limit=10","last":"https://api.mailgun.net/v4/templates?page=last&limit=10"}},"key":"Example","summary":"Example","id":"paths/~1v4~1templates/get/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1templates/post/responses/200/content/application~1json/examples/Example":{"value":{"message":"template has been stored","template":{"name":"template_name","description":"This is the description of the template","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","createdBy":"user-supplied-value","id":"46565d87-68b6-4edb-8b3c-34554af4bb77","domain":"header.tld","version":{"tag":"tag","template":"<html>template content</html>","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","comment":"Version comment","active":true,"id":"3efd2b85-0f41-4a1d-9898-05d7e7459c4a","headers":{"From":"from@header.tld","Reply-To":"reply-to@header.tld","Subject":"Subject Value"}}}},"key":"Example","summary":"Example","id":"paths/~1v4~1templates/post/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1templates/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"templates have been deleted"},"key":"Example","summary":"Example","id":"paths/~1v4~1templates/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1templates~1{template_name}~1versions/get/responses/200/content/application~1json/examples/Example":{"value":{"template":{"name":"template_name","description":"This is the description of the template","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","createdBy":"user-supplied-value","id":"46565d87-68b6-4edb-8b3c-34554af4bb77","domain":"example.com","versions":[{"tag":"v0","template":"","engine":"","mjml":"","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","comment":"version comment","active":false,"id":"71bd07b8-fe81-4199-8fcf-67c956ccdc34","headers":{},"parsedhandlebar":null},{"tag":"v1","template":"","engine":"","mjml":"","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","comment":"version comment","active":true,"id":"d4a36e91-1b5f-44e0-bf5a-3542ea712b62","headers":{},"parsedhandlebar":null}]},"paging":{"previous":"https://api.mailgun.net/v4/templates/my-template/versions?page=previous&p=v0&limit=10","first":"https://api.mailgun.net/v4/templates/my-template/versions?limit=10","next":"https://api.mailgun.net/v4/templates/my-template/versions?page=next&p=v1&limit=10","last":"https://api.mailgun.net/v4/templates/my-template/versions?page=last&limit=10"}},"key":"Example","summary":"Example","id":"paths/~1v4~1templates~1{template_name}~1versions/get/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1templates~1{template_name}~1versions/post/responses/200/content/application~1json/examples/Example":{"value":{"message":"new version of the template has been stored","template":{"name":"template_name","description":"This is the description of the template","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","createdBy":"user-supplied-value","id":"46565d87-68b6-4edb-8b3c-34554af4bb77","domain":"header.tld","version":{"tag":"tag","template":"<html>template content</html>","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","comment":"Version comment","active":true,"id":"3efd2b85-0f41-4a1d-9898-05d7e7459c4a","headers":{"From":"from@header.tld","Reply-To":"reply-to@header.tld","Subject":"Subject Value"}}}},"key":"Example","summary":"Example","id":"paths/~1v4~1templates~1{template_name}~1versions/post/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1templates~1{template_name}/get/responses/200/content/application~1json/examples/Example":{"value":{"template":{"name":"template_name","description":"This is the description of the template","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","createdBy":"user-supplied-value","id":"46565d87-68b6-4edb-8b3c-34554af4bb77","domain":"header.tld","version":{"tag":"tag","template":"<html>template content</html>","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","comment":"Version comment","active":true,"id":"3efd2b85-0f41-4a1d-9898-05d7e7459c4a","headers":{"From":"from@header.tld","Reply-To":"reply-to@header.tld","Subject":"Subject Value"}}}},"key":"Example","summary":"Example","id":"paths/~1v4~1templates~1{template_name}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1templates~1{template_name}/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"template has been updated","template":{"name":"template_name"}},"key":"Example","summary":"Example","id":"paths/~1v4~1templates~1{template_name}/put/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1templates~1{template_name}/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"template has been deleted","template":{"name":"template_name"}},"key":"Example","summary":"Example","id":"paths/~1v4~1templates~1{template_name}/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/get/responses/200/content/application~1json/examples/Example":{"value":{"template":{"name":"template_name","description":"This is the description of the template","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","createdBy":"user-supplied-value","id":"46565d87-68b6-4edb-8b3c-34554af4bb77","domain":"header.tld","version":{"tag":"tag","template":"<html>template content</html>","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","comment":"Version comment","active":true,"id":"3efd2b85-0f41-4a1d-9898-05d7e7459c4a","headers":{"From":"from@header.tld","Reply-To":"reply-to@header.tld","Subject":"Subject Value"}}}},"key":"Example","summary":"Example","id":"paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"version has been updated","template":{"name":"template_name","version":{"tag":"tag"}}},"key":"Example","summary":"Example","id":"paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/put/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"version has been deleted","template":{"name":"template_name","version":{"tag":"tag"}}},"key":"Example","summary":"Example","id":"paths/~1v4~1templates~1{template_name}~1versions~1{version_name}/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1templates~1{template_name}~1copy/put/requestBody/content/application~1json/examples/Example":{"value":{"requests":[{"account_id":"account-id-1","name":"new-template-name-1"},{"account_id":"account-id-2","name":"new-template-name-2","domain":"target-domain"}]},"key":"Example","summary":"Example","id":"paths/~1v4~1templates~1{template_name}~1copy/put/requestBody/content/application~1json/examples/Example"},"paths/~1v4~1templates~1{template_name}~1copy/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"Templates have been copied","failed_copies":[{"account_id":"account-id-1","name":"new-template-name-1"},{"account_id":"account-id-2","name":"new-template-name-2","domain":"target-domain"}]},"key":"Example","summary":"Example","id":"paths/~1v4~1templates~1{template_name}~1copy/put/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1templates~1{template_name}~1versions~1{version_name}~1copy~1{new_version_name}/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"version has been copied","version":{"tag":"cloned version","template":"<p>{{firstname}} {{lastname}}</p>","createdAt":"Fri, 21 Mar 2025 15:00:44 UTC","comment":"a comment value from copy","id":"95658c55-e93a-40d5-a02f-a4fadfbbb3ca"}},"key":"Example","summary":"Example","id":"paths/~1v4~1templates~1{template_name}~1versions~1{version_name}~1copy~1{new_version_name}/put/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1templates~1{template_name}~1rename~1{new_template_name}/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"Template has been renamed","template":{"name":"new-template-name"}},"key":"Example","summary":"Example","id":"paths/~1v4~1templates~1{template_name}~1rename~1{new_template_name}/put/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1templates/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"name":"template.0","description":"Description for template 0","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","id":"48d63154-8c8f-4104-ab14-687d01dbf296"},{"name":"template.1","description":"Description for template 1","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","id":"8d9c0f0d-7bf7-43a4-92a9-791a854d12a4"}],"paging":{"previous":"https://api.mailgun.net/v3/{domain}/templates?page=previous&p=template.0&limit=10","first":"https://api.mailgun.net/v3/{domain}/templates?limit=10","next":"https://api.mailgun.net/v3/{domain}/templates?page=next&p=template.2&limit=10","last":"https://api.mailgun.net/v3/{domain}/templates?page=last&limit=10"}},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1templates/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1templates/post/responses/200/content/application~1json/examples/Example":{"value":{"message":"template has been stored","template":{"name":"template_name","description":"This is the description of the template","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","createdBy":"user-supplied-value","id":"46565d87-68b6-4edb-8b3c-34554af4bb77","domain":"header.tld","version":{"tag":"tag","template":"<html>template content</html>","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","comment":"Version comment","active":true,"id":"3efd2b85-0f41-4a1d-9898-05d7e7459c4a","headers":{"From":"from@header.tld","Reply-To":"reply-to@header.tld","Subject":"Subject Value"}}}},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1templates/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1templates/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"templates have been deleted"},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1templates/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions/get/responses/200/content/application~1json/examples/Example":{"value":{"template":{"name":"template_name","description":"This is the description of the template","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","createdBy":"user-supplied-value","id":"46565d87-68b6-4edb-8b3c-34554af4bb77","domain":"example.com","versions":[{"tag":"v0","template":"","engine":"","mjml":"","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","comment":"version comment","active":false,"id":"71bd07b8-fe81-4199-8fcf-67c956ccdc34","headers":{},"parsedhandlebar":null},{"tag":"v1","template":"","engine":"","mjml":"","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","comment":"version comment","active":true,"id":"d4a36e91-1b5f-44e0-bf5a-3542ea712b62","headers":{},"parsedhandlebar":null},{"tag":"v2","template":"","engine":"","mjml":"","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","comment":"version comment","active":true,"id":"d4a36e91-1b5f-44e0-bf5a-3542ea712b62","headers":{},"parsedhandlebar":null}]},"paging":{"previous":"https://api.mailgun.net/v3/{domain}/templates/z4ujt7CiEeik0RJbspqxaQ/versions?page=previous&p=v0&limit=10","first":"https://api.mailgun.net/v3/{domain}/templates/z4ujt7CiEeik0RJbspqxaQ/versions?limit=10","next":"https://api.mailgun.net/v3/{domain}/templates/z4ujt7CiEeik0RJbspqxaQ/versions?page=next&p=v2&limit=10","last":"https://api.mailgun.net/v3/{domain}/templates/z4ujt7CiEeik0RJbspqxaQ/versions?page=last&limit=10"}},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions/post/responses/200/content/application~1json/examples/Example":{"value":{"message":"new version of the template has been stored","template":{"name":"template_name","description":"This is the description of the template","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","createdBy":"user-supplied-value","id":"46565d87-68b6-4edb-8b3c-34554af4bb77","domain":"header.tld","version":{"tag":"tag","template":"<html>template content</html>","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","comment":"Version comment","active":true,"id":"3efd2b85-0f41-4a1d-9898-05d7e7459c4a","headers":{"From":"from@header.tld","Reply-To":"reply-to@header.tld","Subject":"Subject Value"}}}},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1templates~1{template_name}/get/responses/200/content/application~1json/examples/Example":{"value":{"template":{"name":"template_name","description":"This is the description of the template","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","createdBy":"user-supplied-value","id":"46565d87-68b6-4edb-8b3c-34554af4bb77","domain":"header.tld","version":{"tag":"tag","template":"<html>template content</html>","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","comment":"Version comment","active":true,"id":"3efd2b85-0f41-4a1d-9898-05d7e7459c4a","headers":{"From":"from@header.tld","Reply-To":"reply-to@header.tld","Subject":"Subject Value"}}}},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1templates~1{template_name}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1templates~1{template_name}/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"template has been updated","template":{"name":"template_name"}},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1templates~1{template_name}/put/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1templates~1{template_name}/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"template has been deleted","template":{"name":"template_name"}},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1templates~1{template_name}/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/get/responses/200/content/application~1json/examples/Example":{"value":{"template":{"name":"template_name","description":"This is the description of the template","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","createdBy":"user-supplied-value","id":"46565d87-68b6-4edb-8b3c-34554af4bb77","domain":"header.tld","version":{"tag":"tag","template":"<html>template content</html>","createdAt":"Sat, 12 Nov 1955 06:38:00 UTC","comment":"Version comment","active":true,"id":"3efd2b85-0f41-4a1d-9898-05d7e7459c4a","headers":{"From":"from@header.tld","Reply-To":"reply-to@header.tld","Subject":"Subject Value"}}}},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"version has been updated","template":{"name":"template_name","version":{"tag":"tag"}}},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/put/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"version has been deleted","template":{"name":"template_name","version":{"tag":"tag"}}},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1templates~1{template_name}~1copy/put/requestBody/content/application~1json/examples/Example":{"value":{"requests":[{"account_id":"account-id-1","name":"new-template-name-1"},{"account_id":"account-id-2","name":"new-template-name-2","domain":"target-domain"}]},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1templates~1{template_name}~1copy/put/requestBody/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1templates~1{template_name}~1copy/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"Templates have been copied","failed_copies":[{"account_id":"account-id-1","name":"new-template-name-1"},{"account_id":"account-id-2","name":"new-template-name-2","domain":"target-domain"}]},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1templates~1{template_name}~1copy/put/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}~1copy~1{new_version_name}/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"version has been copied","version":{"tag":"cloned version","template":"<p>{{firstname}} {{lastname}}</p>","createdAt":"Fri, 21 Mar 2025 15:00:44 UTC","comment":"a comment value from copy","id":"95658c55-e93a-40d5-a02f-a4fadfbbb3ca"}},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1templates~1{template_name}~1versions~1{version_name}~1copy~1{new_version_name}/put/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1{domain_name}~1templates~1{template_name}~1rename~1{new_template_name}/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"Template has been renamed","template":{"name":"new-template-name"}},"key":"Example","summary":"Example","id":"paths/~1v3~1{domain_name}~1templates~1{template_name}~1rename~1{new_template_name}/put/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}~1ips~1{ip}/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"success"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}~1ips~1{ip}/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}~1pool~1{ip}/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"success"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}~1pool~1{ip}/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ip_pools/get/responses/200/content/application~1json/examples/Example":{"value":{"ip_pools":[{"description":"long description of the dedicated IP pool","ips":["1.0.0.1","1.0.0.2"],"metadata":{"assignments":{"1.0.0.1":{"linked_at":"2006-01-02T15:04:05Z"},"1.0.0.2":{"linked_at":"2006-01-02T15:04:05Z"}}},"is_inherited":true,"is_linked":true,"name":"short name of the dedicated IP pool","pool_id":"the id of the dedicated IP pool"}],"message":"success"},"key":"Example","summary":"Example","id":"paths/~1v3~1ip_pools/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ip_pools/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"description of the error"},"key":"Example","summary":"Example","id":"paths/~1v3~1ip_pools/get/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1ip_pools/post/responses/200/content/application~1json/examples/Example":{"value":{"message":"success","pool_id":"658041ae44842b99ee2eaa1b"},"key":"Example","summary":"Example","id":"paths/~1v3~1ip_pools/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ip_pools~1{pool_id}/get/responses/200/content/application~1json/examples/Example":{"value":{"details":{"description":"A long description of the DIPP","ips":["1.2.3.4","5.6.7.8"],"is_linked":true,"linked_domains":["a.example.com","b.example.com"],"name":"DIPP's short name","pool_id":"658041ae44842b99ee2eaa1b"},"message":"success"},"key":"Example","summary":"Example","id":"paths/~1v3~1ip_pools~1{pool_id}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ip_pools~1{pool_id}/delete/responses/200/content/application~1json/examples/Example":{"value":{"allowed":{"dedicated":1,"shared":2}},"key":"Example","summary":"Example","id":"paths/~1v3~1ip_pools~1{pool_id}/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ip_pools~1{pool_id}/patch/responses/200/content/application~1json/examples/Example":{"value":{"message":"success"},"key":"Example","summary":"Example","id":"paths/~1v3~1ip_pools~1{pool_id}/patch/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ip_pools~1{pool_id}~1domains/get/responses/200/content/application~1json/examples/Example":{"value":{"domains":[{"id":"69c42eba4fac947ac7bb3406","name":"example1.com"},{"id":"69c42eba4fac947ac7bb3407","name":"example2.com"}],"paging":{"first":"http://api.mailgun.net/v3/ip_pools/69c42eba4fac947ac7bb3405/domains?page=eyJj...","next":"http://api.mailgun.net/v3/ip_pools/69c42eba4fac947ac7bb3405/domains?page=eyJj..."}},"key":"Example","summary":"Example","id":"paths/~1v3~1ip_pools~1{pool_id}~1domains/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ip_pools~1{pool_id}~1ips~1{ip}/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"started"},"key":"Example","summary":"Example","id":"paths/~1v3~1ip_pools~1{pool_id}~1ips~1{ip}/put/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ip_pools~1{pool_id}~1ips~1{ip}/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"started"},"key":"Example","summary":"Example","id":"paths/~1v3~1ip_pools~1{pool_id}~1ips~1{ip}/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ip_pools~1{pool_id}~1ips.json/post/requestBody/content/application~1json/examples/Example":{"value":{"ips":["1.2.3.4","5.6.7.8"]},"key":"Example","summary":"Example","id":"paths/~1v3~1ip_pools~1{pool_id}~1ips.json/post/requestBody/content/application~1json/examples/Example"},"paths/~1v3~1ip_pools~1{pool_id}~1ips.json/post/responses/200/content/application~1json/examples/Example":{"value":{"message":"started"},"key":"Example","summary":"Example","id":"paths/~1v3~1ip_pools~1{pool_id}~1ips.json/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ip_pools~1{pool_id}~1delegate/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"success"},"key":"Example","summary":"Example","id":"paths/~1v3~1ip_pools~1{pool_id}~1delegate/put/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ip_pools~1{pool_id}~1delegate/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"success"},"key":"Example","summary":"Example","id":"paths/~1v3~1ip_pools~1{pool_id}~1delegate/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}~1dynamic_pools/post/responses/200/content/application~1json/examples/Example":{"value":{"message":"success"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}~1dynamic_pools/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{name}~1dynamic_pools/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"success"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{name}~1dynamic_pools/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1dynamic_pools~1assignable/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"account_id":"69c42eba4fac947ac7bb33fc","id":"69c42eba4fac947ac7bb33fb","name":"example.com"}]},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1dynamic_pools~1assignable/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1all~1dynamic_pools~1enroll/post/responses/200/content/application~1json/examples/Example":{"value":{"message":"started"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1all~1dynamic_pools~1enroll/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1dynamic_pools/get/responses/200/content/application~1json/examples/Example":{"value":{"poor_reputation":["1.0.0.3"],"new_senders":["1.0.0.4"],"pools":[{"account_id":"69c42eba4fac947ac7bb3401","enabled":true,"id":"69c42eba4fac947ac7bb3402","ips":["1.0.0.1","1.0.0.2"],"name":"dynamic_good"},{"account_id":"69c42eba4fac947ac7bb3401","enabled":true,"id":"69c42eba4fac947ac7bb3403","ips":["1.0.0.3"],"name":"dynamic_poor"},{"account_id":"69c42eba4fac947ac7bb3401","enabled":true,"id":"69c42eba4fac947ac7bb3404","ips":["1.0.0.4"],"name":"dynamic_new"}],"good_reputation":["1.0.0.1","1.0.0.2"]},"key":"Example","summary":"Example","id":"paths/~1v3~1dynamic_pools/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1dynamic_pools~1all/post/responses/200/content/application~1json/examples/Example":{"value":{"good_reputation":["1.0.0.1","1.0.0.2"],"poor_reputation":["1.0.0.3"],"new_senders":["1.0.0.4"]},"key":"Example","summary":"Example","id":"paths/~1v3~1dynamic_pools~1all/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1dynamic_pools~1all/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"success"},"key":"Example","summary":"Example","id":"paths/~1v3~1dynamic_pools~1all/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1dynamic_pools~1{pool_name}~1{ip}/post/responses/200/content/application~1json/examples/Example":{"value":"this is needed just so that examples are included into the output","key":"Example","summary":"Example","id":"paths/~1v3~1dynamic_pools~1{pool_name}~1{ip}/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1dynamic_pools~1{pool_name}/patch/responses/200/content/application~1json/examples/Example":{"value":{"message":"success"},"key":"Example","summary":"Example","id":"paths/~1v3~1dynamic_pools~1{pool_name}/patch/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1dynamic_pools~1domains/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"id":"68d16780d1ffb196ac7b2cc8","account_id":"68d16780d1ffb196ac7b2cc9","name":"example.com","registered_at":"0001-01-01T00:00:00Z","pool":"dynamic_good","bounce_rate":0.01,"complaint_rate":0.1,"processed_count":100},{"id":"68d16780d1ffb196ac7b2cca","account_id":"68d16780d1ffb196ac7b2ccb","name":"example.com","registered_at":"0001-01-01T00:00:00Z","pool":"dynamic_good","bounce_rate":0.01,"complaint_rate":0,"processed_count":100}],"total_items":2,"paging":{}},"key":"Example","summary":"Example","id":"paths/~1v1~1dynamic_pools~1domains/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1dynamic_pools~1domains/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"description of the error"},"key":"Example","summary":"Example","id":"paths/~1v1~1dynamic_pools~1domains/get/responses/400/content/application~1json/examples/Example"},"paths/~1v1~1dynamic_pools~1domains~1{name}~1preview/get/responses/200/content/application~1json/examples/Example":{"value":{"pool":"dynamic_poor","results":{"bounce_rate":{"value":0.25,"band":"dynamic_poor"},"complaint_rate":{"value":0.0002,"band":"dynamic_good"},"processed_count":{"value":25000,"band":"dynamic_good"}}},"key":"Example","summary":"Example","id":"paths/~1v1~1dynamic_pools~1domains~1{name}~1preview/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1dynamic_pools~1domains~1{name}~1history/get/responses/200/content/application~1json/examples/Example":{"value":{"id":"000000000000000000000000","owning_account_id":"000000000000000000000000","account_id":"68d16780d1ffb196ac7b2ccd","domain_id":"68d16780d1ffb196ac7b2ccc","domain_name":"test.com","new_band":"dynamic_good","prev_band":"dynamic_poor","reason":"Multiple metrics in good threshold","bounce_rate":0.2,"complaint_rate":0.1,"processed_count":100,"timestamp":"2025-09-22T11:13:04.740262-04:00"},"key":"Example","summary":"Example","id":"paths/~1v1~1dynamic_pools~1domains~1{name}~1history/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1dynamic_pools~1domains~1{name}~1override/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"success"},"key":"Example","summary":"Example","id":"paths/~1v1~1dynamic_pools~1domains~1{name}~1override/put/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1dynamic_pools~1domains~1{name}~1override/put/responses/400/content/application~1json/examples/Example":{"value":{"Field":"pool","Value":"invalid_name"},"key":"Example","summary":"Example","id":"paths/~1v1~1dynamic_pools~1domains~1{name}~1override/put/responses/400/content/application~1json/examples/Example"},"paths/~1v1~1dynamic_pools~1domains~1{name}~1override/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"success"},"key":"Example","summary":"Example","id":"paths/~1v1~1dynamic_pools~1domains~1{name}~1override/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1dynamic_pools~1history/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"id":"68d16780d1ffb196ac7b2cce","owning_account_id":"000000000000000000000000","account_id":"68d16780d1ffb196ac7b2ccf","account_name":"My Account","domain_id":"68d16780d1ffb196ac7b2cd0","domain_name":"test.com","new_band":"dynamic_good","prev_band":"dynamic_poor","reason":"bounce_rate in good threshold","bounce_rate":0.04,"complaint_rate":0.0001,"initiated_by":"system","timestamp":"0001-01-01T00:00:00Z"},{"id":"68d16780d1ffb196ac7b2cd1","owning_account_id":"000000000000000000000000","account_id":"68d16780d1ffb196ac7b2cd2","account_name":"My Account","domain_id":"68d16780d1ffb196ac7b2cd3","domain_name":"test.com","new_band":"dynamic_good","prev_band":"dynamic_new","reason":"Multiple metrics in good threshold","bounce_rate":0.04,"complaint_rate":0.0001,"initiated_by":"system","timestamp":"0001-01-01T00:00:00Z"}],"total_items":2,"paging":{}},"key":"Example","summary":"Example","id":"paths/~1v1~1dynamic_pools~1history/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1dynamic_pools~1history/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"description of the error"},"key":"Example","summary":"Example","id":"paths/~1v1~1dynamic_pools~1history/get/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1ips~1domain~1{name}/get/responses/200/content/application~1json/examples/Example":{"value":{"extra_dedicated_ips":{"pool_id":"6a219e7515415d72b6e47358"}},"key":"Example","summary":"Example","id":"paths/~1v3~1ips~1domain~1{name}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ips~1domain~1{name}/patch/requestBody/content/application~1json/examples/Example":{"value":{"extra_dedicated_ips":{"pool_id":"6a219e7515415d72b6e47359"}},"key":"Example","summary":"Example","id":"paths/~1v3~1ips~1domain~1{name}/patch/requestBody/content/application~1json/examples/Example"},"paths/~1v3~1ips~1domain~1{name}/patch/responses/200/content/application~1json/examples/Example":{"value":{"message":"success"},"key":"Example","summary":"Example","id":"paths/~1v3~1ips~1domain~1{name}/patch/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ips~1account~1settings/get/responses/200/content/application~1json/examples/Example":{"value":{"extra_dedicated_ips":{"pool_id":"6a219e7515415d72b6e4735f"}},"key":"Example","summary":"Example","id":"paths/~1v3~1ips~1account~1settings/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ips~1account~1settings/patch/requestBody/content/application~1json/examples/Example":{"value":{"extra_dedicated_ips":{"pool_id":"6a219e7515415d72b6e47360"}},"key":"Example","summary":"Example","id":"paths/~1v3~1ips~1account~1settings/patch/requestBody/content/application~1json/examples/Example"},"paths/~1v3~1ips~1account~1settings/patch/responses/200/content/application~1json/examples/Example":{"value":{"message":"success"},"key":"Example","summary":"Example","id":"paths/~1v3~1ips~1account~1settings/patch/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ips/get/responses/200/content/application~1json/examples/Example":{"value":{"assignable_to_pools":["5.6.7.8"],"details":[{"ip":"1.2.3.4","is_on_warmup":true},{"ip":"5.6.7.8"}],"items":["1.2.3.4","5.6.7.8"],"total_count":2},"key":"Example","summary":"Example","id":"paths/~1v3~1ips/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ips~1{ip}/get/responses/200/content/application~1json/examples/Example":{"value":{"dedicated":true,"ip":"1.2.3.4","rdns":"ip1-2-3-4.mailgun.net"},"key":"Example","summary":"Example","id":"paths/~1v3~1ips~1{ip}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ips~1{ip}~1domains/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"ips":["1.2.3.4","5.6.7.8"],"domain":"one.example.com"},{"ips":["1.2.3.4"],"domain":"two.example.com"}],"total_count":2},"key":"Example","summary":"Example","id":"paths/~1v3~1ips~1{ip}~1domains/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ips~1{ip}~1domains/post/responses/200/content/application~1json/examples/Example":{"value":{"message":"started","reference_id":"61926093321d1cba88f3b95b"},"key":"Example","summary":"Example","id":"paths/~1v3~1ips~1{ip}~1domains/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ips~1{ip}~1domains/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"started","reference_id":"61926093321d1cba88f3b95b"},"key":"Example","summary":"Example","id":"paths/~1v3~1ips~1{ip}~1domains/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ips~1{addr}~1ip_band/post/responses/200/content/application~1json/examples/Example":{"value":{"message":"success"},"key":"Example","summary":"Example","id":"paths/~1v3~1ips~1{addr}~1ip_band/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ips~1{addr}~1ip_band/post/responses/400/content/application~1json/examples/Example":{"value":{"error":"invalid parameters"},"key":"Example","summary":"Example","id":"paths/~1v3~1ips~1{addr}~1ip_band/post/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1ips~1{addr}~1ip_band/post/responses/403/content/application~1json/examples/Example":{"value":{"error":"\"Dedicated IP Bands\" feature is not enabled for this account"},"key":"Example","summary":"Example","id":"paths/~1v3~1ips~1{addr}~1ip_band/post/responses/403/content/application~1json/examples/Example"},"paths/~1v3~1ips~1{addr}~1ip_band/post/responses/404/content/application~1json/examples/Example":{"value":{"error":"IP not found or doesn't belong to the account"},"key":"Example","summary":"Example","id":"paths/~1v3~1ips~1{addr}~1ip_band/post/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1ips~1{addr}~1ip_band/post/responses/409/content/application~1json/examples/Example":{"value":{"error":"IP is already locked"},"key":"Example","summary":"Example","id":"paths/~1v3~1ips~1{addr}~1ip_band/post/responses/409/content/application~1json/examples/Example"},"paths/~1v3~1ips~1request~1new/get/responses/200/content/application~1json/examples/Example":{"value":{"allowed":{"dedicated":1,"shared":2}},"key":"Example","summary":"Example","id":"paths/~1v3~1ips~1request~1new/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ips~1request~1new/post/responses/200/content/application~1json/examples/Example":{"value":{"message":"success"},"key":"Example","summary":"Example","id":"paths/~1v3~1ips~1request~1new/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ips~1details~1all/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"GroupedAccountIP":{"address":"1.0.0.1","account_ids":["69c42eba4fac947ac7bb33fd","69c42eba4fac947ac7bb33fe","69c42eba4fac947ac7bb33ff"],"parent_account_id":"69c42eba4fac947ac7bb33fd","created_at":"2026-02-09T12:30:00Z"},"warmup_stage":{"Number":1,"StartVolume":50,"Quota":{"StartTime":"2026-02-09T12:00:00Z","VolumeLimit":200}}},{"GroupedAccountIP":{"address":"1.0.0.2","account_ids":["69c42eba4fac947ac7bb33fd"],"parent_account_id":"69c42eba4fac947ac7bb33fd","pool_count":1,"created_at":"2026-02-09T12:30:00Z"}},{"GroupedAccountIP":{"address":"1.0.0.3","account_ids":["69c42eba4fac947ac7bb33fd"],"parent_account_id":"69c42eba4fac947ac7bb33fd","created_at":"2026-02-09T12:30:00Z"}}],"total_count":3},"key":"Example","summary":"Example","id":"paths/~1v3~1ips~1details~1all/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ips~1subaccounts/patch/responses/200/content/application~1json/examples/Example":{"value":{"message":"success"},"key":"Example","summary":"Example","id":"paths/~1v3~1ips~1subaccounts/patch/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ips~1subaccounts/patch/responses/400/content/application~1json/examples/Example":{"value":{"message":"invalid request parameters"},"key":"Example","summary":"Example","id":"paths/~1v3~1ips~1subaccounts/patch/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1ips~1subaccounts/patch/responses/403/content/application~1json/examples/Example":{"value":{"message":"centralized assignment is not enabled for account"},"key":"Example","summary":"Example","id":"paths/~1v3~1ips~1subaccounts/patch/responses/403/content/application~1json/examples/Example"},"paths/~1v3~1ips~1subaccounts/patch/responses/404/content/application~1json/examples/Example":{"value":{"message":"subaccount not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1ips~1subaccounts/patch/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1ip_warmups/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"ip":"1.0.0.1","sent_within_stage":"0%","throttle":78,"stage_number":3,"stage_start_volume":14000,"stage_start_time":"2025-01-01T00:00:00Z","stage_volume_limit":4000},{"ip":"1.0.0.2","sent_within_stage":"25%","throttle":90,"stage_number":4,"stage_start_volume":10000,"stage_start_time":"2025-01-01T00:00:00Z","stage_volume_limit":8000}],"paging":{"first":"first","next":"next"}},"key":"Example","summary":"Example","id":"paths/~1v3~1ip_warmups/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ip_warmups~1{addr}/get/responses/200/content/application~1json/examples/Example":{"value":{"details":{"sent_within_stage":"20%","throttle":78,"start_volume":10000,"stage":2,"stage_limit":4000,"hourly_limit":100,"stage_started_at":"2025-01-01T00:00:00Z","hour_started_at":"2025-01-01T00:00:00Z","plan_started_at":"2025-01-01T00:00:00Z","plan_last_updated_at":"2025-01-01T00:00:00Z","total_stages":15,"stage_history":[{"first_updated_at":"0001-01-01T00:00:00Z","completed_at":"2025-06-03T21:33:55.000000123Z","limit":1000},{"first_updated_at":"0001-01-01T00:00:00Z","completed_at":"2025-06-04T18:11:20.000000456Z","limit":2000},{"first_updated_at":"0001-01-01T00:00:00Z","completed_at":"2025-06-04T14:22:17.000000789Z","limit":4000}]}},"key":"Example","summary":"Example","id":"paths/~1v3~1ip_warmups~1{addr}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ip_warmups~1{addr}/post/responses/200/content/application~1json/examples/Example":{"value":{"message":"success"},"key":"Example","summary":"Example","id":"paths/~1v3~1ip_warmups~1{addr}/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1ip_warmups~1{addr}/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"success"},"key":"Example","summary":"Example","id":"paths/~1v3~1ip_warmups~1{addr}/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}/get/responses/200/content/application~1json/examples/Example":{"value":{"subaccount":{"id":"123","name":"My subaccount","created_at":"Wed, 06 Nov 2024 19:48:29 GMT","updated_at":"Wed, 28 May 2025 20:03:05 GMT","status":"open"}},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}/get/responses/404/content/application~1json/examples/Example":{"value":{"message":"Not Found"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}/get/responses/404/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1subaccounts/get/responses/200/content/application~1json/examples/Example":{"value":{"subaccounts":[{"id":"123","name":"My subaccount","status":"open","created_at":"Wed, 06 Nov 2024 19:48:29 GMT","updated_at":"Wed, 28 May 2025 20:03:05 GMT"}],"total":1},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1subaccounts/get/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1subaccounts/post/responses/200/content/application~1json/examples/Example":{"value":{"subaccount":{"id":"123","name":"My subaccount","created_at":"Wed, 06 Nov 2024 19:48:29 GMT","updated_at":"Wed, 28 May 2025 20:03:05 GMT","status":"open"}},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1subaccounts/post/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1subaccounts/post/responses/400/content/application~1json/examples/Example":{"value":{"message":"Bad request"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1subaccounts/post/responses/400/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1subaccounts/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"Subaccount successfully deleted"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1subaccounts/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1subaccounts/delete/responses/400/content/application~1json/examples/Example":{"value":{"message":"Bad request"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1subaccounts/delete/responses/400/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1subaccounts/delete/responses/403/content/application~1json/examples/Example":{"value":{"message":"Forbidden"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1subaccounts/delete/responses/403/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1disable/post/responses/200/content/application~1json/examples/Example":{"value":{"subaccount":{"id":"123","name":"My subaccount","created_at":"Wed, 06 Nov 2024 19:48:29 GMT","updated_at":"Wed, 28 May 2025 20:03:05 GMT","status":"disabled"}},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1disable/post/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1disable/post/responses/400/content/application~1json/examples/Example":{"value":{"message":"subaccount is already disabled"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1disable/post/responses/400/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1disable/post/responses/404/content/application~1json/examples/Example":{"value":{"message":"Not Found"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1disable/post/responses/404/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1enable/post/responses/200/content/application~1json/examples/Example":{"value":{"subaccount":{"id":"123","name":"My subaccount","created_at":"Wed, 06 Nov 2024 19:48:29 GMT","updated_at":"Wed, 28 May 2025 20:03:05 GMT","status":"open"}},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1enable/post/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1enable/post/responses/400/content/application~1json/examples/Example":{"value":{"message":"Parent account has reached its allotted child limit"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1enable/post/responses/400/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1enable/post/responses/404/content/application~1json/examples/Example":{"value":{"message":"Not Found"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1enable/post/responses/404/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/responses/200/content/application~1json/examples/Example":{"value":{"limit":10000,"current":0,"period":"1m"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"Not a subaccount"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/responses/400/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/responses/403/content/application~1json/examples/Example":{"value":{"message":"Forbidden - user does not have permission to view this resource"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/responses/403/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/responses/404/content/application~1json/examples/Example":{"value":{"message":"No threshold for account"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/get/responses/404/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/put/responses/200/content/application~1json/examples/Example":{"value":{"success":true},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/put/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/put/responses/400/content/application~1json/examples/Example":{"value":{"message":"Invalid subaccount ID"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/put/responses/400/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/delete/responses/200/content/application~1json/examples/Example":{"value":{"success":true},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/delete/responses/400/content/application~1json/examples/Example":{"value":{"message":"Could not delete threshold for account"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1limit~1custom~1monthly/delete/responses/400/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1features/put/responses/200/content/application~1json/examples/Example":{"value":{"features":{"validations":{"enabled":true}}},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1features/put/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1features/put/responses/400/content/application~1json/examples/Example":{"value":{"message":"No valid updates provided"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1features/put/responses/400/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1features/put/responses/404/content/application~1json/examples/Example":{"value":{"message":"Not Found"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1subaccounts~1{subaccount_id}~1features/put/responses/404/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1limit~1custom~1monthly/get/responses/200/content/application~1json/examples/Example":{"value":{"limit":10000,"current":0,"period":"1m"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1limit~1custom~1monthly/get/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1limit~1custom~1monthly/get/responses/404/content/application~1json/examples/Example":{"value":{"message":"No threshold for account"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1limit~1custom~1monthly/get/responses/404/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1limit~1custom~1monthly/put/responses/200/content/application~1json/examples/Example":{"value":{"success":true},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1limit~1custom~1monthly/put/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1limit~1custom~1monthly/put/responses/400/content/application~1json/examples/Example":{"value":{"message":"The limit parameter minumum is 1000"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1limit~1custom~1monthly/put/responses/400/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1limit~1custom~1monthly/delete/responses/200/content/application~1json/examples/Example":{"value":{"success":true},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1limit~1custom~1monthly/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1limit~1custom~1monthly/delete/responses/400/content/application~1json/examples/Example":{"value":{"message":"Could not delete threshold for account"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1limit~1custom~1monthly/delete/responses/400/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1limit~1custom~1enable/put/responses/200/content/application~1json/examples/Example":{"value":{"success":true},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1limit~1custom~1enable/put/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1limit~1custom~1enable/put/responses/400/content/application~1json/examples/Example":{"value":{"message":"Unable to re-enable account with current account disablement"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1limit~1custom~1enable/put/responses/400/content/application~1json/examples/Example"},"paths/~1v5~1accounts/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"Account info has been updated"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts/put/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1accounts/put/responses/400/content/application~1json/examples/Example":{"value":{"message":"Either `name`, `absolute_timeout`, `inactive_timeout`, or `logout_redirect_url` must be provided to update account info."},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts/put/responses/400/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1http_signing_key/get/responses/200/content/application~1json/examples/Example":{"value":{"http_signing_key":"key-55c5c5c5c55f55ca5cd5f55d5c555c55"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1http_signing_key/get/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1http_signing_key/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"could not get HSK for account"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1http_signing_key/get/responses/400/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1http_signing_key/post/responses/200/content/application~1json/examples/Example":{"value":{"message":"regenerated HTTP signing key for account","http_signing_key":"key-55c5c5c5c55f55ca5cd5f55d5c555c55"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1http_signing_key/post/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1sandbox~1auth_recipients/get/responses/200/content/application~1json/examples/Example":{"value":{"recipients":[{"email":"test_recipient@sandbox.com","activated":true}]},"key":"Example","summary":"Example","id":"paths/~1v5~1sandbox~1auth_recipients/get/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1sandbox~1auth_recipients/post/responses/200/content/application~1json/examples/Example":{"value":{"recipient":{"email":"test_recipient@sandbox.com","activated":false}},"key":"Example","summary":"Example","id":"paths/~1v5~1sandbox~1auth_recipients/post/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1sandbox~1auth_recipients/post/responses/400/content/application~1json/examples/Example":{"value":{"message":"Only 5 sandbox recipients are allowed"},"key":"Example","summary":"Example","id":"paths/~1v5~1sandbox~1auth_recipients/post/responses/400/content/application~1json/examples/Example"},"paths/~1v5~1sandbox~1auth_recipients~1{email}/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"Sandbox recipient deleted."},"key":"Example","summary":"Example","id":"paths/~1v5~1sandbox~1auth_recipients~1{email}/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1sandbox~1auth_recipients~1{email}/delete/responses/400/content/application~1json/examples/Example":{"value":{"message":"Invalid email address."},"key":"Example","summary":"Example","id":"paths/~1v5~1sandbox~1auth_recipients~1{email}/delete/responses/400/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1resend_activation_email/post/responses/200/content/application~1json/examples/Example":{"value":{"success":true},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1resend_activation_email/post/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1features/put/responses/200/content/application~1json/examples/Example":{"value":{"success":true},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1features/put/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1accounts~1features/put/responses/400/content/application~1json/examples/Example":{"value":{"message":"No valid updates provided"},"key":"Example","summary":"Example","id":"paths/~1v5~1accounts~1features/put/responses/400/content/application~1json/examples/Example"},"paths/~1v1~1keys/get/responses/200/content/application~1json/examples/Example":{"value":{"total_count":1,"items":[{"id":"e2153fd0-e0277777","description":"api key","kind":"user","role":"admin","created_at":"2006-01-02T15:04:05","updated_at":"2006-01-02T15:04:05","requestor":"janedoe@example.com","user_name":"Jane Doe","domain_name":null,"is_disabled":false}]},"key":"Example","summary":"Example","id":"paths/~1v1~1keys/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1keys/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"expected `kind` param to be one of [domain user web] or absent"},"key":"Example","summary":"Example","id":"paths/~1v1~1keys/get/responses/400/content/application~1json/examples/Example"},"paths/~1v1~1keys/post/responses/200/content/application~1json/examples/Example":{"value":{"message":"great success","key":{"id":"f2153fd0-f1277777","description":"api key","kind":"domain","role":"sending","created_at":"2006-01-02T15:04:05","updated_at":"2006-01-02T15:04:05","requestor":null,"user_name":null,"domain_name":"example.com","is_disabled":false,"secret":"api-key-be-careful"}},"key":"Example","summary":"Example","id":"paths/~1v1~1keys/post/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1keys/post/responses/403/content/application~1json/examples/Example":{"value":{"message":"could not create key, account limit reached"},"key":"Example","summary":"Example","id":"paths/~1v1~1keys/post/responses/403/content/application~1json/examples/Example"},"paths/~1v1~1keys~1{key_id}/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"key deleted"},"key":"Example","summary":"Example","id":"paths/~1v1~1keys~1{key_id}/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1keys~1{key_id}/delete/responses/404/content/application~1json/examples/Example":{"value":{"message":"no key matching id"},"key":"Example","summary":"Example","id":"paths/~1v1~1keys~1{key_id}/delete/responses/404/content/application~1json/examples/Example"},"paths/~1v1~1keys~1public/post/responses/200/content/application~1json/examples/Example":{"value":{"key":"pubkey-626b31f321228ddddddddddcc5a7a1c9","message":"The public API key has been successfully regenerated."},"key":"Example","summary":"Example","id":"paths/~1v1~1keys~1public/post/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1keys~1public/post/responses/400/content/application~1json/examples/Example":{"value":{"message":"Forbidden"},"key":"Example","summary":"Example","id":"paths/~1v1~1keys~1public/post/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain_name}~1credentials/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"mailbox":"someone@example.com","login":"someone@example.com","created_at":"Wed, 08 Mar 2023 23:34:57 +0000","size_bytes":null}],"total_count":1},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain_name}~1credentials/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain_name}~1credentials/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"Limit parameter can't be larger than 1000"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain_name}~1credentials/get/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain_name}~1credentials/post/responses/200/content/application~1json/examples/Example":{"value":{"message":"Created 1 credentials pair(s)"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain_name}~1credentials/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain_name}~1credentials/post/responses/400/content/application~1json/examples/Example":{"value":{"message":"Parameter 'login' is missing"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain_name}~1credentials/post/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain_name}~1credentials/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"All domain credentials have been deleted","count":2},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain_name}~1credentials/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain_name}~1credentials/delete/responses/400/content/application~1json/examples/Example":{"value":{"message":"an error occurred, please try again later"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain_name}~1credentials/delete/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"Created 1 credentials pair(s)"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/put/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/put/responses/404/content/application~1json/examples/Example":{"value":{"message":"Credentials not found"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/put/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"Credentials have been deleted","spec":"someone@example.com"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/delete/responses/400/content/application~1json/examples/Example":{"value":{"message":"Cannot delete system mailbox: postmaster@example.com"},"key":"Example","summary":"Example","id":"paths/~1v3~1domains~1{domain_name}~1credentials~1{spec}/delete/responses/400/content/application~1json/examples/Example"},"paths/~1v2~1ip_whitelist/get/responses/200/content/application~1json/examples/Example":{"value":{"addresses":[{"ip_address":"10.11.11.111","description":"OnPrem Server"}]},"key":"Example","summary":"Example","id":"paths/~1v2~1ip_whitelist/get/responses/200/content/application~1json/examples/Example"},"paths/~1v2~1ip_whitelist/get/responses/403/content/application~1json/examples/Example":{"value":{"message":"Forbidden"},"key":"Example","summary":"Example","id":"paths/~1v2~1ip_whitelist/get/responses/403/content/application~1json/examples/Example"},"paths/~1v2~1ip_whitelist/put/responses/200/content/application~1json/examples/Example":{"value":{"addresses":[{"ip_address":"10.11.11.111","description":"OnPrem Server 1"}]},"key":"Example","summary":"Example","id":"paths/~1v2~1ip_whitelist/put/responses/200/content/application~1json/examples/Example"},"paths/~1v2~1ip_whitelist/put/responses/400/content/application~1json/examples/Example":{"value":{"message":"IP not found"},"key":"Example","summary":"Example","id":"paths/~1v2~1ip_whitelist/put/responses/400/content/application~1json/examples/Example"},"paths/~1v2~1ip_whitelist/post/responses/200/content/application~1json/examples/Example":{"value":{"addresses":[{"ip_address":"10.11.11.111","description":"OnPrem Server"}]},"key":"Example","summary":"Example","id":"paths/~1v2~1ip_whitelist/post/responses/200/content/application~1json/examples/Example"},"paths/~1v2~1ip_whitelist/post/responses/400/content/application~1json/examples/Example":{"value":{"message":"Invalid IP Address or CIDR"},"key":"Example","summary":"Example","id":"paths/~1v2~1ip_whitelist/post/responses/400/content/application~1json/examples/Example"},"paths/~1v2~1ip_whitelist/delete/responses/200/content/application~1json/examples/Example":{"value":{"addresses":[]},"key":"Example","summary":"Example","id":"paths/~1v2~1ip_whitelist/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v2~1ip_whitelist/delete/responses/400/content/application~1json/examples/Example":{"value":{"message":"IP address can not be blank"},"key":"Example","summary":"Example","id":"paths/~1v2~1ip_whitelist/delete/responses/400/content/application~1json/examples/Example"},"paths/~1v5~1users/get/responses/200/content/application~1json/examples/Example":{"value":{"users":[{"id":"123","name":"John Doe","activated":true,"is_disabled":false,"email":"johndoe@example.com","email_details":{"address":"johndoe@example.com","is_valid":true,"parts":{"local_part":"johndoe","domain":"example.com"}},"role":"basic","account_id":"567","opened_ip":"67.111.60.111","is_master":true,"metadata":{},"tfa_enabled":true,"tfa_active":true,"tfa_created_at":"2022-12-20T16:52:01.892000","password_updated_at":"2022-12-20T16:52:01.892000","preferences":{"programming_language":"curl","time_format":"%m/%d/%y %I:%M %p","time_zone":"US/Eastern"},"auth":{"method":"sinch","prior_details":{},"prior_method":""},"github_user_id":null,"salesforce_user_id":null,"migration_status":"done"}],"total":1},"key":"Example","summary":"Example","id":"paths/~1v5~1users/get/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1users~1{user_id}/get/responses/200/content/application~1json/examples/Example":{"value":{"id":"123","name":"John Doe","activated":true,"is_disabled":false,"email":"johndoe@example.com","email_details":{"address":"johndoe@example.com","is_valid":true,"parts":{"local_part":"johndoe","domain":"example.com"}},"role":"basic","account_id":"567","opened_ip":"67.111.60.111","is_master":true,"metadata":{},"tfa_enabled":true,"tfa_active":true,"tfa_created_at":"2022-12-20T16:52:01.892000","password_updated_at":"2022-12-20T16:52:01.892000","preferences":{"programming_language":"curl","time_format":"%m/%d/%y %I:%M %p","time_zone":"US/Eastern"},"auth":{"method":"sinch","prior_details":{},"prior_method":""},"github_user_id":null,"salesforce_user_id":null,"migration_status":"done"},"key":"Example","summary":"Example","id":"paths/~1v5~1users~1{user_id}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1users~1{user_id}/get/responses/404/content/application~1json/examples/Example":{"value":{"message":"No such user exists"},"key":"Example","summary":"Example","id":"paths/~1v5~1users~1{user_id}/get/responses/404/content/application~1json/examples/Example"},"paths/~1v5~1users~1me/get/responses/200/content/application~1json/examples/Example":{"value":{"id":"123","name":"John Doe","activated":true,"is_disabled":false,"email":"johndoe@example.com","email_details":{"address":"johndoe@example.com","is_valid":true,"parts":{"local_part":"johndoe","domain":"example.com"}},"role":"basic","account_id":"567","opened_ip":"67.111.60.111","is_master":true,"metadata":{},"tfa_enabled":true,"tfa_active":true,"tfa_created_at":"2022-12-20T16:52:01.892000","password_updated_at":"2022-12-20T16:52:01.892000","preferences":{"programming_language":"curl","time_format":"%m/%d/%y %I:%M %p","time_zone":"US/Eastern"},"auth":{"method":"sinch","prior_details":{},"prior_method":""},"github_user_id":null,"salesforce_user_id":null,"migration_status":"done"},"key":"Example","summary":"Example","id":"paths/~1v5~1users~1me/get/responses/200/content/application~1json/examples/Example"},"paths/~1v5~1users~1me/get/responses/403/content/application~1json/examples/Example":{"value":{"message":"Incompatible key for this endpoint"},"key":"Example","summary":"Example","id":"paths/~1v5~1users~1me/get/responses/403/content/application~1json/examples/Example"}},"securitySchemeStore":{"basicAuth":{"id":"basicAuth","type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}},"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/docs/mailgun/api-reference/send/mailgun","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/mailgun/api-reference/send/mailgun.json?download"},{"url":"/_bundle/docs/mailgun/api-reference/send/mailgun.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Mailgun API","description":"Mailgun API defined by OpenAPI Specification (OAS) 3.1.0"}},"baseSlug":"/docs/mailgun/api-reference/send/mailgun","routesMapping":{}}