{"items":[{"type":"link","label":"Validations Service","link":"/docs/validate/oas/openapi-validate-final","routeSlug":"/docs/validate/oas/openapi-validate-final","content":{"contentType":"overview","meta":{"name":"Validations Service"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi-validate-final.json","url":"/_bundle/docs/validate/oas/openapi-validate-final.json?download"},{"kind":"download","label":"openapi-validate-final.yaml","url":"/_bundle/docs/validate/oas/openapi-validate-final.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":"Validations Service (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Mailgun Email Validation service with RESTful JSON HTTP API for performing email validation. This service also manages list\nand CSV ingestion used in bulk validation processing."}],"sectionId":"/docs/validate/oas/openapi-validate-final"}],"sectionId":"/docs/validate/oas/openapi-validate-final"}]}]}},{"type":"separator","label":"Mailgun Validate","content":null},{"type":"group","label":"Validations","link":"/docs/validate/oas/openapi-validate-final/validations","routeSlug":"/docs/validate/oas/openapi-validate-final/validations","items":[{"label":"Validate Address V4","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/validate/oas/openapi-validate-final/validations/get-v4-address-validate","routeSlug":"/docs/validate/oas/openapi-validate-final/validations/get-v4-address-validate","metadata":{"seo":{"title":"Validate Address V4","description":"A single email address to validate."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v4-address-validate","name":"Validate Address V4","isWebhook":false,"pointer":"/paths/~1v4~1address~1validate/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate Address V4","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"A single email address to validate."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","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":"The address to be validated","required":true},{"name":"provider_lookup","in":"query","schemaId":"schema_179","description":"Enable/disable provider lookup, default is true"}],"pointer":"/paths/~1v4~1address~1validate/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/address/validate","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"},{"name":"provider_lookup","in":"query","schemaId":"schema_179"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/v4/address/validate","href":"validations/get-v4-address-validate","openApiOperationId":"GET-v4-address-validate","summary":"Validate Address 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-validations-validation-steps-base-ValidationResponse","exampleIds":["paths/~1v4~1address~1validate/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-validations-validation-steps-base-ValidationResponse","exampleIds":["paths/~1v4~1address~1validate/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/~1v4~1address~1validate/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-validations-validation-steps-base-ValidationResponse","exampleIds":["paths/~1v4~1address~1validate/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-validations-validation-steps-base-ValidationResponse","exampleIds":["paths/~1v4~1address~1validate/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":"/validations/get-v4-address-validate"}],"panels":[]}]},"httpPath":"/v4/address/validate"}],"content":{"contentType":"group","meta":{"name":"Validations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validations","showPageActions":true},{"nodeType":"markdoc","content":"This API provides functionality to validate single addresses, and managing thresholds."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/address/validate","summary":"Validate Address V4","prefix":{"name":"get","color":"get"},"badges":[],"link":"/validations/get-v4-address-validate","deprecated":false}]}]}]}]}},{"type":"group","label":"Bulk Validations","link":"/docs/validate/oas/openapi-validate-final/bulk-validations","routeSlug":"/docs/validate/oas/openapi-validate-final/bulk-validations","items":[{"label":"Create Bulk Job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/validate/oas/openapi-validate-final/bulk-validations/post-v4-address-validate-bulk--list-id-","routeSlug":"/docs/validate/oas/openapi-validate-final/bulk-validations/post-v4-address-validate-bulk--list-id-","metadata":{"seo":{"title":"Create Bulk Job","description":"Validate a full list of addresses."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v4-address-validate-bulk--list-id-","name":"Create Bulk Job","isWebhook":false,"pointer":"/paths/~1v4~1address~1validate~1bulk~1{list_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Bulk Job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Validate a full list of addresses."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","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_id","in":"path","schemaId":"components/schemas/string","description":"the name for the bulk job must be unique.","required":true}],"pointer":"/paths/~1v4~1address~1validate~1bulk~1{list_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["csv file"],"mediaTypeSchemas":{"csv file":{"schemaId":"components/schemas/POST-v4-address-validate-bulk-list_id-csv-file-RequestBody"}},"schemaId":"components/schemas/POST-v4-address-validate-bulk-list_id-csv-file-RequestBody","pointer":"/paths/~1v4~1address~1validate~1bulk~1{list_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/address/validate/bulk/{list_id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"list_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"csv file":{"schemaId":"components/schemas/POST-v4-address-validate-bulk-list_id-csv-file-RequestBody"}},"responseCodes":["202","default"],"pointer":"/v4/address/validate/bulk/{list_id}","href":"bulk-validations/post-v4-address-validate-bulk--list-id-","openApiOperationId":"POST-v4-address-validate-bulk--list-id-","summary":"Create Bulk Job"},"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-address-validate-bulk-list_id-csv-file-RequestBody","mediaTypes":["csv file"],"mediaTypeSchemas":{"csv file":{"schemaId":"components/schemas/POST-v4-address-validate-bulk-list_id-csv-file-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-validations-api-BulkPostResponse","exampleIds":["paths/~1v4~1address~1validate~1bulk~1{list_id}/post/responses/202/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-validations-api-BulkPostResponse","exampleIds":["paths/~1v4~1address~1validate~1bulk~1{list_id}/post/responses/202/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/~1v4~1address~1validate~1bulk~1{list_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/github.com-mailgun-validations-api-BulkPostResponse","exampleIds":["paths/~1v4~1address~1validate~1bulk~1{list_id}/post/responses/202/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-validations-api-BulkPostResponse","exampleIds":["paths/~1v4~1address~1validate~1bulk~1{list_id}/post/responses/202/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":"/bulk-validations/post-v4-address-validate-bulk--list-id-"}],"panels":[]}]},"httpPath":"/v4/address/validate/bulk/{list_id}"},{"label":"Get Job V4","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/validate/oas/openapi-validate-final/bulk-validations/api.initv4api.(*apihelpers).isfreeorfishy.func2-9","routeSlug":"/docs/validate/oas/openapi-validate-final/bulk-validations/api.initv4api.(*apihelpers).isfreeorfishy.func2-9","metadata":{"seo":{"title":"Get Job V4","description":"Gets a selected job by list ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.InitV4API.(*ApiHelpers).isFreeOrFishy.func2-9","name":"Get Job V4","isWebhook":false,"pointer":"/paths/~1v4~1address~1validate~1bulk~1{list_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Job V4","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a selected job by list 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":"list_id","in":"path","schemaId":"components/schemas/string","description":"The list ID being verified","required":true}],"pointer":"/paths/~1v4~1address~1validate~1bulk~1{list_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Mailgun-Account-Id","in":"header","schemaId":"components/schemas/string","description":"Mailgun Account ID","required":true}],"pointer":"/paths/~1v4~1address~1validate~1bulk~1{list_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/address/validate/bulk/{list_id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"list_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[{"name":"X-Mailgun-Account-Id","in":"header","required":true,"schemaId":"components/schemas/string"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/v4/address/validate/bulk/{list_id}","href":"bulk-validations/api.initv4api.(*apihelpers).isfreeorfishy.func2-9","openApiOperationId":"api.InitV4API.(*ApiHelpers).isFreeOrFishy.func2-9","summary":"Get Job 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/GetResponse","exampleIds":["paths/~1v4~1address~1validate~1bulk~1{list_id}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/GetResponse","exampleIds":["paths/~1v4~1address~1validate~1bulk~1{list_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/Response"}},"schemaId":"components/schemas/Response"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Response"}},"schemaId":"components/schemas/Response"}],"pointer":"/paths/~1v4~1address~1validate~1bulk~1{list_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetResponse","exampleIds":["paths/~1v4~1address~1validate~1bulk~1{list_id}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetResponse","exampleIds":["paths/~1v4~1address~1validate~1bulk~1{list_id}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Response"}}},{"code":"500","schemaId":"components/schemas/Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-validations/api.initv4api.(*apihelpers).isfreeorfishy.func2-9"}],"panels":[]}]},"httpPath":"/v4/address/validate/bulk/{list_id}"},{"label":"Delete Job V4","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/validate/oas/openapi-validate-final/bulk-validations/api.initv4api.(*apihelpers).isfreeorfishy.func1-8","routeSlug":"/docs/validate/oas/openapi-validate-final/bulk-validations/api.initv4api.(*apihelpers).isfreeorfishy.func1-8","metadata":{"seo":{"title":"Delete Job V4","description":"Cancels a selected job by list ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.InitV4API.(*ApiHelpers).isFreeOrFishy.func1-8","name":"Delete Job V4","isWebhook":false,"pointer":"/paths/~1v4~1address~1validate~1bulk~1{list_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Job V4","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels a selected job by list 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":"list_id","in":"path","schemaId":"components/schemas/string","description":"The list ID being verified","required":true}],"pointer":"/paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Mailgun-Account-Id","in":"header","schemaId":"components/schemas/string","description":"Mailgun Account ID","required":true}],"pointer":"/paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v4/address/validate/bulk/{list_id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"list_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[{"name":"X-Mailgun-Account-Id","in":"header","required":true,"schemaId":"components/schemas/string"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404","409","500"],"pointer":"/v4/address/validate/bulk/{list_id}","href":"bulk-validations/api.initv4api.(*apihelpers).isfreeorfishy.func1-8","openApiOperationId":"api.InitV4API.(*ApiHelpers).isFreeOrFishy.func1-8","summary":"Delete Job 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/Response","exampleIds":["paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Response","exampleIds":["paths/~1v4~1address~1validate~1bulk~1{list_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/Response","exampleIds":["paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Response","exampleIds":["paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/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/Response","exampleIds":["paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/responses/409/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Response","exampleIds":["paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/responses/409/content/application~1json/examples/Example"]},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Response","exampleIds":["paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/responses/500/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Response","exampleIds":["paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/responses/500/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Response","exampleIds":["paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Response","exampleIds":["paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/Response","exampleIds":["paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Response","exampleIds":["paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/responses/404/content/application~1json/examples/Example"]}}},{"code":"409","schemaId":"components/schemas/Response","exampleIds":["paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/responses/409/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Response","exampleIds":["paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/responses/409/content/application~1json/examples/Example"]}}},{"code":"500","schemaId":"components/schemas/Response","exampleIds":["paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/responses/500/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Response","exampleIds":["paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/responses/500/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-validations/api.initv4api.(*apihelpers).isfreeorfishy.func1-8"}],"panels":[]}]},"httpPath":"/v4/address/validate/bulk/{list_id}"},{"label":"List Jobs V4","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/validate/oas/openapi-validate-final/bulk-validations/api.initv4api.(*apihelpers).isfreeorfishy.func4-11","routeSlug":"/docs/validate/oas/openapi-validate-final/bulk-validations/api.initv4api.(*apihelpers).isfreeorfishy.func4-11","metadata":{"seo":{"title":"List Jobs V4","description":"Returns all jobs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.InitV4API.(*ApiHelpers).isFreeOrFishy.func4-11","name":"List Jobs V4","isWebhook":false,"pointer":"/paths/~1v4~1address~1validate~1bulk/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Jobs V4","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all jobs."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","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-Account-Id","in":"header","schemaId":"components/schemas/string","description":"Mailgun Account ID","required":true}],"pointer":"/paths/~1v4~1address~1validate~1bulk/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/address/validate/bulk","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-Account-Id","in":"header","required":true,"schemaId":"components/schemas/string"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/v4/address/validate/bulk","href":"bulk-validations/api.initv4api.(*apihelpers).isfreeorfishy.func4-11","openApiOperationId":"api.InitV4API.(*ApiHelpers).isFreeOrFishy.func4-11","summary":"List Jobs 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/GetResponse","exampleIds":["paths/~1v4~1address~1validate~1bulk/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/GetResponse","exampleIds":["paths/~1v4~1address~1validate~1bulk/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/Response"}},"schemaId":"components/schemas/Response"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Response"}},"schemaId":"components/schemas/Response"}],"pointer":"/paths/~1v4~1address~1validate~1bulk/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetResponse","exampleIds":["paths/~1v4~1address~1validate~1bulk/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetResponse","exampleIds":["paths/~1v4~1address~1validate~1bulk/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Response"}}},{"code":"500","schemaId":"components/schemas/Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-validations/api.initv4api.(*apihelpers).isfreeorfishy.func4-11"}],"panels":[]}]},"httpPath":"/v4/address/validate/bulk"},{"label":"Get Job V3","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/validate/oas/openapi-validate-final/bulk-validations/api.initv3api.(*apihelpers).isfreeorfishy.func2-13","routeSlug":"/docs/validate/oas/openapi-validate-final/bulk-validations/api.initv3api.(*apihelpers).isfreeorfishy.func2-13","metadata":{"seo":{"title":"Get Job V3","description":"Gets a selected job by list ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.InitV3API.(*ApiHelpers).isFreeOrFishy.func2-13","name":"Get Job V3","isWebhook":false,"pointer":"/paths/~1v3~1lists~1{list_id}~1validate/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Job V3","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a selected job by list 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":"list_id","in":"path","schemaId":"components/schemas/string","description":"The list ID being verified","required":true}],"pointer":"/paths/~1v3~1lists~1{list_id}~1validate/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Mailgun-Account-Id","in":"header","schemaId":"components/schemas/string","description":"Mailgun Account ID","required":true}],"pointer":"/paths/~1v3~1lists~1{list_id}~1validate/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/lists/{list_id}/validate","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"list_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[{"name":"X-Mailgun-Account-Id","in":"header","required":true,"schemaId":"components/schemas/string"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/v3/lists/{list_id}/validate","href":"bulk-validations/api.initv3api.(*apihelpers).isfreeorfishy.func2-13","openApiOperationId":"api.InitV3API.(*ApiHelpers).isFreeOrFishy.func2-13","summary":"Get Job V3"},"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/GetResponse","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/GetResponse","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/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/Response"}},"schemaId":"components/schemas/Response"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Response"}},"schemaId":"components/schemas/Response"}],"pointer":"/paths/~1v3~1lists~1{list_id}~1validate/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetResponse","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetResponse","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Response"}}},{"code":"500","schemaId":"components/schemas/Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-validations/api.initv3api.(*apihelpers).isfreeorfishy.func2-13"}],"panels":[]}]},"httpPath":"/v3/lists/{list_id}/validate"},{"label":"Create Job V3","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/validate/oas/openapi-validate-final/bulk-validations/api.initv3api.(*apihelpers).isfreeorfishy.func3-14","routeSlug":"/docs/validate/oas/openapi-validate-final/bulk-validations/api.initv3api.(*apihelpers).isfreeorfishy.func3-14","metadata":{"seo":{"title":"Create Job V3","description":"Starts a V3 list validation job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.InitV3API.(*ApiHelpers).isFreeOrFishy.func3-14","name":"Create Job V3","isWebhook":false,"pointer":"/paths/~1v3~1lists~1{list_id}~1validate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Job V3","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Starts a V3 list validation job."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","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_id","in":"path","schemaId":"components/schemas/string","description":"The list ID being verified","required":true}],"pointer":"/paths/~1v3~1lists~1{list_id}~1validate/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Mailgun-Account-Id","in":"header","schemaId":"components/schemas/string","description":"Mailgun Account ID","required":true}],"pointer":"/paths/~1v3~1lists~1{list_id}~1validate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/lists/{list_id}/validate","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"list_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[{"name":"X-Mailgun-Account-Id","in":"header","required":true,"schemaId":"components/schemas/string"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/lists/{list_id}/validate","href":"bulk-validations/api.initv3api.(*apihelpers).isfreeorfishy.func3-14","openApiOperationId":"api.InitV3API.(*ApiHelpers).isFreeOrFishy.func3-14","summary":"Create Job V3"},"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/Response","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Response","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/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/Response","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Response","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/post/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1lists~1{list_id}~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Response","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Response","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/Response","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Response","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/post/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-validations/api.initv3api.(*apihelpers).isfreeorfishy.func3-14"}],"panels":[]}]},"httpPath":"/v3/lists/{list_id}/validate"},{"label":"Delete Job V3","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/validate/oas/openapi-validate-final/bulk-validations/api.initv3api.(*apihelpers).isfreeorfishy.func1-12","routeSlug":"/docs/validate/oas/openapi-validate-final/bulk-validations/api.initv3api.(*apihelpers).isfreeorfishy.func1-12","metadata":{"seo":{"title":"Delete Job V3","description":"Cancels a selected job by list ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api.InitV3API.(*ApiHelpers).isFreeOrFishy.func1-12","name":"Delete Job V3","isWebhook":false,"pointer":"/paths/~1v3~1lists~1{list_id}~1validate/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Job V3","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels a selected job by list 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":"list_id","in":"path","schemaId":"components/schemas/string","description":"The list ID being verified","required":true}],"pointer":"/paths/~1v3~1lists~1{list_id}~1validate/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Mailgun-Account-Id","in":"header","schemaId":"components/schemas/string","description":"Mailgun Account ID","required":true}],"pointer":"/paths/~1v3~1lists~1{list_id}~1validate/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/lists/{list_id}/validate","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"list_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[{"name":"X-Mailgun-Account-Id","in":"header","required":true,"schemaId":"components/schemas/string"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404","409","500"],"pointer":"/v3/lists/{list_id}/validate","href":"bulk-validations/api.initv3api.(*apihelpers).isfreeorfishy.func1-12","openApiOperationId":"api.InitV3API.(*ApiHelpers).isFreeOrFishy.func1-12","summary":"Delete Job V3"},"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/Response","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Response","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/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/Response","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/delete/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Response","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/delete/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/Response","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/delete/responses/409/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Response","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/delete/responses/409/content/application~1json/examples/Example"]},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Response","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/delete/responses/500/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Response","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/delete/responses/500/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v3~1lists~1{list_id}~1validate/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Response","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Response","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/Response","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/delete/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Response","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/delete/responses/404/content/application~1json/examples/Example"]}}},{"code":"409","schemaId":"components/schemas/Response","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/delete/responses/409/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Response","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/delete/responses/409/content/application~1json/examples/Example"]}}},{"code":"500","schemaId":"components/schemas/Response","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/delete/responses/500/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Response","exampleIds":["paths/~1v3~1lists~1{list_id}~1validate/delete/responses/500/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-validations/api.initv3api.(*apihelpers).isfreeorfishy.func1-12"}],"panels":[]}]},"httpPath":"/v3/lists/{list_id}/validate"}],"content":{"contentType":"group","meta":{"name":"Bulk Validations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk Validations","showPageActions":true},{"nodeType":"markdoc","content":"This API provides functionality to upload and manage bulk validation lists and previews."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/address/validate/bulk/{list_id}","summary":"Create Bulk Job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bulk-validations/post-v4-address-validate-bulk--list-id-","deprecated":false},{"title":"/v4/address/validate/bulk/{list_id}","summary":"Get Job V4","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bulk-validations/api.initv4api.(*apihelpers).isfreeorfishy.func2-9","deprecated":false},{"title":"/v4/address/validate/bulk/{list_id}","summary":"Delete Job V4","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/bulk-validations/api.initv4api.(*apihelpers).isfreeorfishy.func1-8","deprecated":false},{"title":"/v4/address/validate/bulk","summary":"List Jobs V4","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bulk-validations/api.initv4api.(*apihelpers).isfreeorfishy.func4-11","deprecated":false},{"title":"/v3/lists/{list_id}/validate","summary":"Get Job V3","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bulk-validations/api.initv3api.(*apihelpers).isfreeorfishy.func2-13","deprecated":false},{"title":"/v3/lists/{list_id}/validate","summary":"Create Job V3","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bulk-validations/api.initv3api.(*apihelpers).isfreeorfishy.func3-14","deprecated":false},{"title":"/v3/lists/{list_id}/validate","summary":"Delete Job V3","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/bulk-validations/api.initv3api.(*apihelpers).isfreeorfishy.func1-12","deprecated":false}]}]}]}]}},{"type":"group","label":"List Health Preview","link":"/docs/validate/oas/openapi-validate-final/list-health-preview","routeSlug":"/docs/validate/oas/openapi-validate-final/list-health-preview","items":[{"label":"Get List Health Preview Job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/validate/oas/openapi-validate-final/list-health-preview/get-v4-address-validate-preview--list-id-","routeSlug":"/docs/validate/oas/openapi-validate-final/list-health-preview/get-v4-address-validate-preview--list-id-","metadata":{"seo":{"title":"Get List Health Preview Job","description":"A single list health preview job by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v4-address-validate-preview--list-id-","name":"Get List Health Preview Job","isWebhook":false,"pointer":"/paths/~1v4~1address~1validate~1preview~1{list_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get List Health Preview Job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"A single list health preview job 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":"list_id","in":"path","schemaId":"components/schemas/string","description":"The list health preview id","required":true}],"pointer":"/paths/~1v4~1address~1validate~1preview~1{list_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/address/validate/preview/{list_id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"list_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":"/v4/address/validate/preview/{list_id}","href":"list-health-preview/get-v4-address-validate-preview--list-id-","openApiOperationId":"GET-v4-address-validate-preview--list-id-","summary":"Get List Health Preview Job"},"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-validations-models-Preview","exampleIds":["paths/~1v4~1address~1validate~1preview~1{list_id}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-validations-models-Preview","exampleIds":["paths/~1v4~1address~1validate~1preview~1{list_id}/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/~1v4~1address~1validate~1preview~1{list_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-validations-models-Preview","exampleIds":["paths/~1v4~1address~1validate~1preview~1{list_id}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-validations-models-Preview","exampleIds":["paths/~1v4~1address~1validate~1preview~1{list_id}/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":"/list-health-preview/get-v4-address-validate-preview--list-id-"}],"panels":[]}]},"httpPath":"/v4/address/validate/preview/{list_id}"},{"label":"Promote List Health Preview Job","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/validate/oas/openapi-validate-final/list-health-preview/put-v4-address-validate-preview--list-id-","routeSlug":"/docs/validate/oas/openapi-validate-final/list-health-preview/put-v4-address-validate-preview--list-id-","metadata":{"seo":{"title":"Promote List Health Preview Job","description":"A currently running list health preview job can be promoted to a full bulk validations job, which will validate all addresses in the list."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v4-address-validate-preview--list-id-","name":"Promote List Health Preview Job","isWebhook":false,"pointer":"/paths/~1v4~1address~1validate~1preview~1{list_id}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Promote List Health Preview Job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"A currently running list health preview job can be promoted to a full bulk validations job, which will validate all addresses in the 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_id","in":"path","schemaId":"components/schemas/string","description":"The list health preview job id","required":true}],"pointer":"/paths/~1v4~1address~1validate~1preview~1{list_id}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v4/address/validate/preview/{list_id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"list_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["202","default"],"pointer":"/v4/address/validate/preview/{list_id}","href":"list-health-preview/put-v4-address-validate-preview--list-id-","openApiOperationId":"PUT-v4-address-validate-preview--list-id-","summary":"Promote List Health Preview Job"},"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-validations-api-BulkPostResponse","exampleIds":["paths/~1v4~1address~1validate~1preview~1{list_id}/put/responses/202/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-validations-api-BulkPostResponse","exampleIds":["paths/~1v4~1address~1validate~1preview~1{list_id}/put/responses/202/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/~1v4~1address~1validate~1preview~1{list_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/github.com-mailgun-validations-api-BulkPostResponse","exampleIds":["paths/~1v4~1address~1validate~1preview~1{list_id}/put/responses/202/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-validations-api-BulkPostResponse","exampleIds":["paths/~1v4~1address~1validate~1preview~1{list_id}/put/responses/202/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":"/list-health-preview/put-v4-address-validate-preview--list-id-"}],"panels":[]}]},"httpPath":"/v4/address/validate/preview/{list_id}"},{"label":"Create a List Health Preview Job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/validate/oas/openapi-validate-final/list-health-preview/post-v4-address-validate-preview--list-id-","routeSlug":"/docs/validate/oas/openapi-validate-final/list-health-preview/post-v4-address-validate-preview--list-id-","metadata":{"seo":{"title":"Create a List Health Preview Job","description":"Start a list health preview job from a list of addresses. We will sample the list and run validations on a small percentage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v4-address-validate-preview--list-id-","name":"Create a List Health Preview Job","isWebhook":false,"pointer":"/paths/~1v4~1address~1validate~1preview~1{list_id}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a List Health Preview Job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Start a list health preview job from a list of addresses. We will sample the list and run validations on a small percentage."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","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_id","in":"path","schemaId":"components/schemas/string","description":"The list health preview job id","required":true}],"pointer":"/paths/~1v4~1address~1validate~1preview~1{list_id}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/address/validate/preview/{list_id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"list_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["202","default"],"pointer":"/v4/address/validate/preview/{list_id}","href":"list-health-preview/post-v4-address-validate-preview--list-id-","openApiOperationId":"POST-v4-address-validate-preview--list-id-","summary":"Create a List Health Preview Job"},"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-validations-api-BulkPostResponse","exampleIds":["paths/~1v4~1address~1validate~1preview~1{list_id}/post/responses/202/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-validations-api-BulkPostResponse","exampleIds":["paths/~1v4~1address~1validate~1preview~1{list_id}/post/responses/202/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/~1v4~1address~1validate~1preview~1{list_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/github.com-mailgun-validations-api-BulkPostResponse","exampleIds":["paths/~1v4~1address~1validate~1preview~1{list_id}/post/responses/202/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-validations-api-BulkPostResponse","exampleIds":["paths/~1v4~1address~1validate~1preview~1{list_id}/post/responses/202/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":"/list-health-preview/post-v4-address-validate-preview--list-id-"}],"panels":[]}]},"httpPath":"/v4/address/validate/preview/{list_id}"},{"label":"Delete List Health Preview Job","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/validate/oas/openapi-validate-final/list-health-preview/delete-v4-address-validate-preview--list-id-","routeSlug":"/docs/validate/oas/openapi-validate-final/list-health-preview/delete-v4-address-validate-preview--list-id-","metadata":{"seo":{"title":"Delete List Health Preview Job","description":"Deletes a single list health previewk job by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v4-address-validate-preview--list-id-","name":"Delete List Health Preview Job","isWebhook":false,"pointer":"/paths/~1v4~1address~1validate~1preview~1{list_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete List Health Preview Job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a single list health previewk job 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":"list_id","in":"path","schemaId":"components/schemas/string","description":"The list health preview job id","required":true}],"pointer":"/paths/~1v4~1address~1validate~1preview~1{list_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v4/address/validate/preview/{list_id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"list_id","in":"path","required":true,"schemaId":"components/schemas/string"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["202","default"],"pointer":"/v4/address/validate/preview/{list_id}","href":"list-health-preview/delete-v4-address-validate-preview--list-id-","openApiOperationId":"DELETE-v4-address-validate-preview--list-id-","summary":"Delete List Health Preview Job"},"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-validations-api-BulkPostResponse","exampleIds":["paths/~1v4~1address~1validate~1preview~1{list_id}/delete/responses/202/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-validations-api-BulkPostResponse","exampleIds":["paths/~1v4~1address~1validate~1preview~1{list_id}/delete/responses/202/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/~1v4~1address~1validate~1preview~1{list_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/github.com-mailgun-validations-api-BulkPostResponse","exampleIds":["paths/~1v4~1address~1validate~1preview~1{list_id}/delete/responses/202/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-validations-api-BulkPostResponse","exampleIds":["paths/~1v4~1address~1validate~1preview~1{list_id}/delete/responses/202/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":"/list-health-preview/delete-v4-address-validate-preview--list-id-"}],"panels":[]}]},"httpPath":"/v4/address/validate/preview/{list_id}"},{"label":"List List Health Preview Jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/validate/oas/openapi-validate-final/list-health-preview/get-v4-address-validate-preview","routeSlug":"/docs/validate/oas/openapi-validate-final/list-health-preview/get-v4-address-validate-preview","metadata":{"seo":{"title":"List List Health Preview Jobs","description":"All list health preview jobs you have started."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v4-address-validate-preview","name":"List List Health Preview Jobs","isWebhook":false,"pointer":"/paths/~1v4~1address~1validate~1preview/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List List Health Preview Jobs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"All list health preview jobs you have started."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","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":"/v4/address/validate/preview","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":"/v4/address/validate/preview","href":"list-health-preview/get-v4-address-validate-preview","openApiOperationId":"GET-v4-address-validate-preview","summary":"List List Health Preview Jobs"},"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-validations-api-ListPreviewResponse","exampleIds":["paths/~1v4~1address~1validate~1preview/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-validations-api-ListPreviewResponse","exampleIds":["paths/~1v4~1address~1validate~1preview/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/~1v4~1address~1validate~1preview/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-validations-api-ListPreviewResponse","exampleIds":["paths/~1v4~1address~1validate~1preview/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-validations-api-ListPreviewResponse","exampleIds":["paths/~1v4~1address~1validate~1preview/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":"/list-health-preview/get-v4-address-validate-preview"}],"panels":[]}]},"httpPath":"/v4/address/validate/preview"}],"content":{"contentType":"group","meta":{"name":"List Health Preview"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Health Preview","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/address/validate/preview/{list_id}","summary":"Get List Health Preview Job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/list-health-preview/get-v4-address-validate-preview--list-id-","deprecated":false},{"title":"/v4/address/validate/preview/{list_id}","summary":"Promote List Health Preview Job","prefix":{"name":"put","color":"put"},"badges":[],"link":"/list-health-preview/put-v4-address-validate-preview--list-id-","deprecated":false},{"title":"/v4/address/validate/preview/{list_id}","summary":"Create a List Health Preview Job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/list-health-preview/post-v4-address-validate-preview--list-id-","deprecated":false},{"title":"/v4/address/validate/preview/{list_id}","summary":"Delete List Health Preview Job","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/list-health-preview/delete-v4-address-validate-preview--list-id-","deprecated":false},{"title":"/v4/address/validate/preview","summary":"List List Health Preview Jobs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/list-health-preview/get-v4-address-validate-preview","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/github.com-mailgun-validations-validation-AddressParts":{"id":"components/schemas/github.com-mailgun-validations-validation-AddressParts","kind":"json-schema","title":"github.com-mailgun-validations-validation-AddressParts","data":{"type":"object","properties":{"display_name":{"type":"object"},"domain":{"type":"object"},"local_part":{"type":"object"}},"required":["display_name","domain","local_part"]}},"components/schemas/github.com-mailgun-validations-validation-V3Response":{"id":"components/schemas/github.com-mailgun-validations-validation-V3Response","kind":"json-schema","title":"github.com-mailgun-validations-validation-V3Response","data":{"type":"object","properties":{"address":{"type":"string"},"did_you_mean":{"type":"object"},"is_disposable_address":{"type":"boolean"},"is_role_address":{"type":"boolean"},"is_valid":{"type":"boolean"},"mailbox_verification":{"type":"string"},"parts":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-validations-validation-AddressParts"},{"type":"null"}]},"reason":{"type":"object"}},"required":["address","did_you_mean","is_disposable_address","is_role_address","is_valid","mailbox_verification","parts","reason"]}},"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/github.com-mailgun-validations-validation-V3ParseResponse":{"id":"components/schemas/github.com-mailgun-validations-validation-V3ParseResponse","kind":"json-schema","title":"github.com-mailgun-validations-validation-V3ParseResponse","data":{"type":"object","properties":{"parsed":{"type":"array","items":{"type":"string"}},"unparseable":{"type":"array","items":{"type":"string"}}},"required":["parsed","unparseable"]}},"components/schemas/github.com-mailgun-validations-api-getThresholdResp":{"id":"components/schemas/github.com-mailgun-validations-api-getThresholdResp","kind":"json-schema","title":"github.com-mailgun-validations-api-getThresholdResp","data":{"type":"object","properties":{"threshold":{"type":["integer","null"],"format":"int32"},"current":{"type":["integer","null"],"format":"int32"},"triggered":{"type":"boolean"}},"required":["threshold","current","triggered"]}},"components/schemas/github.com-mailgun-validations-api-BulkPostResponse":{"id":"components/schemas/github.com-mailgun-validations-api-BulkPostResponse","kind":"json-schema","title":"github.com-mailgun-validations-api-BulkPostResponse","data":{"type":"object","properties":{"id":{"type":"string"},"message":{"type":"string"}},"required":["id","message"]}},"components/schemas/POST-v4-address-validate-bulk-list_id-csv-file-RequestBody":{"id":"components/schemas/POST-v4-address-validate-bulk-list_id-csv-file-RequestBody","kind":"json-schema","title":"POST-v4-address-validate-bulk-list_id-csv-file-RequestBody","data":{"type":"object","properties":{"":{"type":"object","description":"a CSV file, with header row, of emails to validate; the \"email\" column must be present"}},"required":[""]}},"components/schemas/github.com-mailgun-validations-api-PreviewPostResponse":{"id":"components/schemas/github.com-mailgun-validations-api-PreviewPostResponse","kind":"json-schema","title":"github.com-mailgun-validations-api-PreviewPostResponse","data":{"type":"object","properties":{"id":{"type":"string"},"message":{"type":"string"}},"required":["id","message"]}},"components/schemas/github.com-mailgun-validations-models-Preview":{"id":"components/schemas/github.com-mailgun-validations-models-Preview","kind":"json-schema","title":"github.com-mailgun-validations-models-Preview","data":{"type":"object","properties":{"id":{"type":"string"},"valid":{"type":"boolean"},"status":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"created_at":{"type":"integer","format":"int64"},"summary":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"number","format":"float"}}},"reason":{"type":"string"}},"required":["id","valid","status","quantity","created_at"]}},"components/schemas/github.com-mailgun-validations-api-ListPreviewResponse":{"id":"components/schemas/github.com-mailgun-validations-api-ListPreviewResponse","kind":"json-schema","title":"github.com-mailgun-validations-api-ListPreviewResponse","data":{"type":"object","properties":{"previews":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-validations-models-Preview"}}},"required":["previews"]}},"components/schemas/github.com-mailgun-validations-validation-engagement-EngagementData":{"id":"components/schemas/github.com-mailgun-validations-validation-engagement-EngagementData","kind":"json-schema","title":"github.com-mailgun-validations-validation-engagement-EngagementData","data":{"type":"object","properties":{"engaging":{"type":"boolean"},"behavior":{"type":"string"},"is_bot":{"type":"boolean"}},"required":["engaging","is_bot"]}},"components/schemas/github.com-mailgun-validations-validation-steps-base-ValidationResponse":{"id":"components/schemas/github.com-mailgun-validations-validation-steps-base-ValidationResponse","kind":"json-schema","title":"github.com-mailgun-validations-validation-steps-base-ValidationResponse","data":{"type":"object","properties":{"address":{"type":"string"},"did_you_mean":{"type":"string"},"engagement":{"anyOf":[{"$ref":"#/components/schemas/github.com-mailgun-validations-validation-engagement-EngagementData"},{"type":"null"}]},"is_disposable_address":{"type":"boolean"},"is_role_address":{"type":"boolean"},"reason":{"type":"array","items":{"type":"string"}},"result":{"type":"string"},"risk":{"type":"string"},"root_address":{"type":"string"},"last_seen":{"type":"integer","format":"int32"}},"required":["address","is_disposable_address","is_role_address","reason","result","risk"]}},"components/schemas/string":{"id":"components/schemas/string","kind":"json-schema","title":"string","data":{"type":"string"}},"components/schemas/Response":{"id":"components/schemas/Response","kind":"json-schema","title":"Response","data":{"type":"object","additionalProperties":{"type":"object"}}},"components/schemas/GetResponse":{"id":"components/schemas/GetResponse","kind":"json-schema","title":"GetResponse","data":{"type":"object","properties":{"is_preview":{"type":"boolean"},"created_at":{"type":"integer","format":"int32"},"download_url":{"type":"object","properties":{"json":{"type":"string"},"csv":{"type":"string"}},"required":["csv","json"]},"id":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"records_processed":{"type":"integer","format":"int32"},"status":{"type":"string"},"summary":{"type":"object","properties":{"engagement":{"type":"object","properties":{"no_data":{"type":"integer","format":"int32"},"highly_engaged":{"type":"integer","format":"int32"},"engaged":{"type":"integer","format":"int32"},"bot":{"type":"integer","format":"int32"},"complainer":{"type":"integer","format":"int32"},"disengaged":{"type":"integer","format":"int32"}},"required":["highly_engaged","engaged","bot","complainer","disengaged","no_data"]},"result":{"type":"object","properties":{"unknown":{"type":"integer","format":"int32"},"catch_all":{"type":"integer","format":"int32"},"deliverable":{"type":"integer","format":"int32"},"do_not_send":{"type":"integer","format":"int32"},"undeliverable":{"type":"integer","format":"int32"},"accept_all":{"type":"integer","format":"int32"}},"required":["catch_all","deliverable","do_not_send","undeliverable","unknown","accept_all"]},"risk":{"type":"object","properties":{"unknown":{"type":"integer","format":"int32"},"high":{"type":"integer","format":"int32"},"low":{"type":"integer","format":"int32"},"medium":{"type":"integer","format":"int32"}},"required":["high","low","medium","unknown"]}}},"reason":{"type":"string"}},"required":["created_at","id","quantity","records_processed"]}},"schema_179":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_179"}},"exampleStore":{"paths/~1v4~1address~1validate/get/responses/200/content/application~1json/examples/Example":{"value":{"address":"john_snow@yaho.com","did_you_mean":"john_snow@yahoo.com","engagement":{},"reason":[],"result":"deliverable","risk":"low"},"key":"Example","summary":"Example","id":"paths/~1v4~1address~1validate/get/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1address~1validate~1bulk~1{list_id}/post/responses/202/content/application~1json/examples/Example":{"value":{"id":"example_list_id","message":"The validation job was submitted."},"key":"Example","summary":"Example","id":"paths/~1v4~1address~1validate~1bulk~1{list_id}/post/responses/202/content/application~1json/examples/Example"},"paths/~1v4~1address~1validate~1bulk~1{list_id}/get/responses/200/content/application~1json/examples/Example":{"value":{"quantity":10000,"id":"some-job-name","summary":{"risk":{"high":30,"low":8000,"medium":1010,"unknown":460},"result":{"donotsend":30,"undeliverable":500,"unknown":460,"catchall":10,"deliverable":9000}},"download_url":{"csv":"https://some-aws-or-gcp-host/file.csv.zip","json":"https://some-aws-or-gcp-host/file.json.zip"},"status":"uploaded","created_at":160000000},"key":"Example","summary":"Example","id":"paths/~1v4~1address~1validate~1bulk~1{list_id}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"Validation job canceled."},"key":"Example","summary":"Example","id":"paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/responses/404/content/application~1json/examples/Example":{"value":{"message":"No validation job processing for list"},"key":"Example","summary":"Example","id":"paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/responses/404/content/application~1json/examples/Example"},"paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/responses/409/content/application~1json/examples/Example":{"value":{"message":"The job state is '[bad_state]' and is no longer cancellable"},"key":"Example","summary":"Example","id":"paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/responses/409/content/application~1json/examples/Example"},"paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/responses/500/content/application~1json/examples/Example":{"value":{"message":"Failed to cancel job, please contact support"},"key":"Example","summary":"Example","id":"paths/~1v4~1address~1validate~1bulk~1{list_id}/delete/responses/500/content/application~1json/examples/Example"},"paths/~1v4~1address~1validate~1bulk/get/responses/200/content/application~1json/examples/Example":{"value":{"total":2,"jobs":[{"created_at":160000001,"id":"some-job-name","quantity":10000,"records_processed":3202,"status":"processing"},{"created_at":160000000,"download_url":{"csv":"https://some-aws-or-gcp-host/file.csv.zip","json":"https://some-aws-or-gcp-host/file.json.zip"},"id":"some-job-name","quantity":10000,"status":"uploaded","summary":{"engagement":null,"result":{"catchall":10,"deliverable":9000,"donotsend":30,"undeliverable":500,"unknown":460},"risk":{"high":30,"low":8000,"medium":1010,"unknown":460}}}],"paging":{"prev":"http://localhost/v4/address/validate/bulk?limit=10&page=prev&pivot=","first":"http://localhost/v4/address/validate/bulk?limit=10&page=first&pivot=","last":"http://localhost/v4/address/validate/bulk?limit=10&page=last&pivot=","next":"http://localhost/v4/address/validate/bulk?limit=10&page=next&pivot="}},"key":"Example","summary":"Example","id":"paths/~1v4~1address~1validate~1bulk/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_id}~1validate/get/responses/200/content/application~1json/examples/Example":{"value":{"created_at":160000000,"id":"some-list@ninomail.com","download_url":{"csv":"https://some-aws-or-gcp-host/file.csv.zip","json":"https://some-aws-or-gcp-host/file.json.zip"},"quantity":10000,"status":"uploaded","summary":{"result":{"catchall":10,"deliverable":9000,"donotsend":30,"undeliverable":500,"unknown":460},"risk":{"high":30,"low":8000,"medium":1010,"unknown":460}}},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_id}~1validate/get/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_id}~1validate/post/responses/200/content/application~1json/examples/Example":{"value":{"message":"The validation job was submitted."},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_id}~1validate/post/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_id}~1validate/post/responses/400/content/application~1json/examples/Example":{"value":{"message":"Validation job is already active."},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_id}~1validate/post/responses/400/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_id}~1validate/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"Validation job canceled."},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_id}~1validate/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_id}~1validate/delete/responses/404/content/application~1json/examples/Example":{"value":{"message":"No validation job processing for list"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_id}~1validate/delete/responses/404/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_id}~1validate/delete/responses/409/content/application~1json/examples/Example":{"value":{"message":"The job state is '[bad_state]' and is no longer cancellable"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_id}~1validate/delete/responses/409/content/application~1json/examples/Example"},"paths/~1v3~1lists~1{list_id}~1validate/delete/responses/500/content/application~1json/examples/Example":{"value":{"message":"Failed to cancel job, please contact support"},"key":"Example","summary":"Example","id":"paths/~1v3~1lists~1{list_id}~1validate/delete/responses/500/content/application~1json/examples/Example"},"paths/~1v4~1address~1validate~1preview~1{list_id}/get/responses/200/content/application~1json/examples/Example":{"value":{"id":"SampleList","valid":true,"status":"preview_complete","quantity":1,"created_at":1234567890,"summary":{"result":{"deliverable":100,"do_not_send":0,"undeliverable":0,"unknown":0},"risk":{"high":0,"low":100,"medium":0,"unknown":0}}},"key":"Example","summary":"Example","id":"paths/~1v4~1address~1validate~1preview~1{list_id}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1address~1validate~1preview~1{list_id}/put/responses/202/content/application~1json/examples/Example":{"value":{"Response":{"id":"example_list_id","message":"The bulk preview job was promoted to a bulk validation job."},"Status":202},"key":"Example","summary":"Example","id":"paths/~1v4~1address~1validate~1preview~1{list_id}/put/responses/202/content/application~1json/examples/Example"},"paths/~1v4~1address~1validate~1preview~1{list_id}/post/responses/202/content/application~1json/examples/Example":{"value":{"id":"example_list_id","message":"The validation preview was submitted."},"key":"Example","summary":"Example","id":"paths/~1v4~1address~1validate~1preview~1{list_id}/post/responses/202/content/application~1json/examples/Example"},"paths/~1v4~1address~1validate~1preview~1{list_id}/delete/responses/202/content/application~1json/examples/Example":{"value":{"id":"example_list_id","message":"The bulk preview was deleted."},"key":"Example","summary":"Example","id":"paths/~1v4~1address~1validate~1preview~1{list_id}/delete/responses/202/content/application~1json/examples/Example"},"paths/~1v4~1address~1validate~1preview/get/responses/200/content/application~1json/examples/Example":{"value":{"previews":[{"id":"SampleList","valid":true,"status":"preview_complete","quantity":1,"created_at":1234567890,"summary":{"result":{"deliverable":100,"do_not_send":0,"undeliverable":0,"unknown":0},"risk":{"high":0,"low":100,"medium":0,"unknown":0}}}]},"key":"Example","summary":"Example","id":"paths/~1v4~1address~1validate~1preview/get/responses/200/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/validate/oas/openapi-validate-final","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/validate/oas/openapi-validate-final.json?download"},{"url":"/_bundle/docs/validate/oas/openapi-validate-final.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Validations Service","description":"Mailgun Email Validation service with RESTful JSON HTTP API for performing email validation. This service also manages list\nand CSV ingestion used in bulk validation processing."}},"baseSlug":"/docs/validate/oas/openapi-validate-final","routesMapping":{}}