{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/communication:sendgrid-domain-authentication-v3/email-dns-record":{"post":{"operationId":"communication_sendgrid_domain_authentication_v3_email_dns_record","summary":"Email DNS records to a co-worker","description":"POST /v3/whitelabel/dns/email","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-domain-authentication-v3/list-authenticated-domain":{"get":{"operationId":"communication_sendgrid_domain_authentication_v3_list_authenticated_domain","summary":"List all authenticated domains","description":"GET /v3/whitelabel/domains","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"`limit` sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default…","schema":{"type":"integer","description":"`limit` sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default…"}},{"name":"offset","in":"query","required":false,"description":"The number of items in the list to skip over before starting to retrieve the items for the requested page. The default `offset` of `0`…","schema":{"type":"integer","default":0,"description":"The number of items in the list to skip over before starting to retrieve the items for the requested page. The default `offset` of `0`…"}},{"name":"exclude_subusers","in":"query","required":false,"description":"Exclude subuser domains from the result.","schema":{"type":"boolean","description":"Exclude subuser domains from the result."}},{"name":"username","in":"query","required":false,"description":"The username associated with an authenticated domain.","schema":{"type":"string","description":"The username associated with an authenticated domain."}},{"name":"domain","in":"query","required":false,"description":"Search for authenticated domains.","schema":{"type":"string","description":"Search for authenticated domains."}},{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-domain-authentication-v3/authenticate-domain":{"post":{"operationId":"communication_sendgrid_domain_authentication_v3_authenticate_domain","summary":"Authenticate a domain","description":"POST /v3/whitelabel/domains","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-domain-authentication-v3/get-authenticated-domain":{"get":{"operationId":"communication_sendgrid_domain_authentication_v3_get_authenticated_domain","summary":"Retrieve an authenticated domain","description":"GET /v3/whitelabel/domains/{domain_id}","tags":["communication"],"parameters":[{"name":"domain_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-domain-authentication-v3/update-authenticated-domain":{"post":{"operationId":"communication_sendgrid_domain_authentication_v3_update_authenticated_domain","summary":"Update an authenticated domain","description":"PATCH /v3/whitelabel/domains/{domain_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain_id"],"properties":{"domain_id":{"type":"string"},"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-domain-authentication-v3/delete-authenticated-domain":{"post":{"operationId":"communication_sendgrid_domain_authentication_v3_delete_authenticated_domain","summary":"Delete an authenticated domain.","description":"DELETE /v3/whitelabel/domains/{domain_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain_id"],"properties":{"domain_id":{"type":"string"},"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-domain-authentication-v3/associate-subuser-with-domain":{"post":{"operationId":"communication_sendgrid_domain_authentication_v3_associate_subuser_with_domain","summary":"Associate an authenticated domain with a given user.","description":"POST /v3/whitelabel/domains/{domain_id}/subuser","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain_id"],"properties":{"domain_id":{"type":"integer","description":"ID of the authenticated domain to associate with the subuser."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-domain-authentication-v3/disassociate-subuser-from-domain":{"post":{"operationId":"communication_sendgrid_domain_authentication_v3_disassociate_subuser_from_domain","summary":"Disassociate an authenticated domain from a given user for users with up to five associated domains.","description":"DELETE /v3/whitelabel/domains/{domain_id}/subuser","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain_id"],"properties":{"username":{"type":"string","description":"Username for the subuser to find associated authenticated domain."},"domain_id":{"type":"integer","description":"ID of the authenticated domain to be disassociated with the subuser."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-domain-authentication-v3/associate-subuser-with-domain-multiple":{"post":{"operationId":"communication_sendgrid_domain_authentication_v3_associate_subuser_with_domain_multiple","summary":"Associate an authenticated domain with a given user, for up to five domains.","description":"POST /v3/whitelabel/domains/{domain_id}/subuser:add","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain_id"],"properties":{"domain_id":{"type":"integer","description":"ID of the authenticated domain to associate with the subuser."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-domain-authentication-v3/add-ip-to-authenticated-domain":{"post":{"operationId":"communication_sendgrid_domain_authentication_v3_add_ip_to_authenticated_domain","summary":"Add an IP to an authenticated domain","description":"POST /v3/whitelabel/domains/{id}/ips","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"ID of the domain to which you are adding an IP"},"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-domain-authentication-v3/delete-ip-from-authenticated-domain":{"post":{"operationId":"communication_sendgrid_domain_authentication_v3_delete_ip_from_authenticated_domain","summary":"Remove an IP from an authenticated domain.","description":"DELETE /v3/whitelabel/domains/{id}/ips/{ip}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","ip"],"properties":{"id":{"type":"integer","description":"ID of the domain to delete the IP from."},"ip":{"type":"string","description":"IP to remove from the domain."},"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-domain-authentication-v3/validate-authenticated-domain":{"post":{"operationId":"communication_sendgrid_domain_authentication_v3_validate_authenticated_domain","summary":"Validate a domain authentication.","description":"POST /v3/whitelabel/domains/{id}/validate","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"ID of the domain to validate."},"on-behalf-of":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-domain-authentication-v3/list-default-authenticated-domain":{"get":{"operationId":"communication_sendgrid_domain_authentication_v3_list_default_authenticated_domain","summary":"Get the default authentication","description":"GET /v3/whitelabel/domains/default","tags":["communication"],"parameters":[{"name":"domain","in":"query","required":false,"description":"The domain to find a default authentication.","schema":{"type":"string","description":"The domain to find a default authentication."}},{"name":"on-behalf-of","in":"query","required":false,"description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…","schema":{"type":"string","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-domain-authentication-v3/list-authenticated-domain-with-user":{"get":{"operationId":"communication_sendgrid_domain_authentication_v3_list_authenticated_domain_with_user","summary":"List the authenticated domain associated with the given user.","description":"GET /v3/whitelabel/domains/subuser","tags":["communication"],"parameters":[{"name":"username","in":"query","required":true,"description":"Username for the subuser to find associated authenticated domain.","schema":{"type":"string","description":"Username for the subuser to find associated authenticated domain."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-domain-authentication-v3/disassociate-authenticated-domain-from-user":{"post":{"operationId":"communication_sendgrid_domain_authentication_v3_disassociate_authenticated_domain_from_user","summary":"Disassociate an authenticated domain from a given user.","description":"DELETE /v3/whitelabel/domains/subuser","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"username":{"type":"string","description":"Username for the subuser to find associated authenticated domain."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-domain-authentication-v3/list-all-authenticated-domain-with-user":{"get":{"operationId":"communication_sendgrid_domain_authentication_v3_list_all_authenticated_domain_with_user","summary":"List all the authenticated domains associated with the given user.","description":"GET /v3/whitelabel/domains/subuser/all","tags":["communication"],"parameters":[{"name":"username","in":"query","required":true,"description":"Username for the subuser to find associated authenticated domains.","schema":{"type":"string","description":"Username for the subuser to find associated authenticated domains."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}