{"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-suppressions-v3/list-asm-group":{"get":{"operationId":"communication_sendgrid_suppressions_v3_list_asm_group","summary":"Retrieve all suppression groups associated with the user.","description":"GET /v3/asm/groups","tags":["communication"],"parameters":[{"name":"id","in":"query","required":false,"description":"The ID of the suppression group(s) you want to retrieve.","schema":{"type":"integer","description":"The ID of the suppression group(s) you want to retrieve."}},{"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-suppressions-v3/creat-asm-group":{"post":{"operationId":"communication_sendgrid_suppressions_v3_creat_asm_group","summary":"Create a new suppression group","description":"POST /v3/asm/groups","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-suppressions-v3/get-asm-group":{"get":{"operationId":"communication_sendgrid_suppressions_v3_get_asm_group","summary":"Get information on a single suppression group.","description":"GET /v3/asm/groups/{group_id}","tags":["communication"],"parameters":[{"name":"group_id","in":"query","required":true,"description":"The ID of the suppression group you would like to retrieve.","schema":{"type":"string","description":"The ID of the suppression group you would like to retrieve."}},{"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-suppressions-v3/update-asm-group":{"post":{"operationId":"communication_sendgrid_suppressions_v3_update_asm_group","summary":"Update a suppression group.","description":"PATCH /v3/asm/groups/{group_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["group_id"],"properties":{"group_id":{"type":"string","description":"The ID of the suppression group you would like to retrieve."},"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-suppressions-v3/delete-asm-group":{"post":{"operationId":"communication_sendgrid_suppressions_v3_delete_asm_group","summary":"Delete a Suppression Group","description":"DELETE /v3/asm/groups/{group_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["group_id"],"properties":{"group_id":{"type":"string","description":"The ID of the suppression group you would like to retrieve."},"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-suppressions-v3/list-suppression-from-asm-group":{"get":{"operationId":"communication_sendgrid_suppressions_v3_list_suppression_from_asm_group","summary":"Retrieve all suppressions for a suppression group","description":"GET /v3/asm/groups/{group_id}/suppressions","tags":["communication"],"parameters":[{"name":"group_id","in":"query","required":true,"description":"The id of the unsubscribe group that you are adding suppressions to.","schema":{"type":"string","description":"The id of the unsubscribe group that you are adding suppressions to."}},{"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-suppressions-v3/add-suppression-to-asm-group":{"post":{"operationId":"communication_sendgrid_suppressions_v3_add_suppression_to_asm_group","summary":"Add suppressions to a suppression group","description":"POST /v3/asm/groups/{group_id}/suppressions","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["group_id"],"properties":{"group_id":{"type":"string","description":"The id of the unsubscribe group that you are adding suppressions to."},"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-suppressions-v3/delete-suppression-from-asm-group":{"post":{"operationId":"communication_sendgrid_suppressions_v3_delete_suppression_from_asm_group","summary":"Delete a suppression from a suppression group","description":"DELETE /v3/asm/groups/{group_id}/suppressions/{email}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["group_id","email"],"properties":{"group_id":{"type":"string","description":"The id of the suppression group that you are removing an email address from."},"email":{"type":"string","description":"The email address that you want to remove from the suppression group."},"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-suppressions-v3/search-suppression-from-asm-group":{"post":{"operationId":"communication_sendgrid_suppressions_v3_search_suppression_from_asm_group","summary":"Search for suppressions within a group","description":"POST /v3/asm/groups/{group_id}/suppressions/search","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["group_id"],"properties":{"group_id":{"type":"string","description":"The ID of the suppression group that you would like to search."},"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-suppressions-v3/list-asm-suppression":{"get":{"operationId":"communication_sendgrid_suppressions_v3_list_asm_suppression","summary":"Retrieve all suppressions","description":"GET /v3/asm/suppressions","tags":["communication"],"parameters":[{"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-suppressions-v3/get-asm-suppression":{"get":{"operationId":"communication_sendgrid_suppressions_v3_get_asm_suppression","summary":"Retrieve all suppression groups for an email address","description":"GET /v3/asm/suppressions/{email}","tags":["communication"],"parameters":[{"name":"email","in":"query","required":true,"description":"The email address that you want to search suppression groups for.","schema":{"type":"string","description":"The email address that you want to search suppression groups for."}},{"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-suppressions-v3/list-suppression-block":{"get":{"operationId":"communication_sendgrid_suppressions_v3_list_suppression_block","summary":"Retrieve all blocks","description":"GET /v3/suppression/blocks","tags":["communication"],"parameters":[{"name":"start_time","in":"query","required":false,"description":"The start of the time range when a blocked email was created (inclusive). This is a unix timestamp.","schema":{"type":"integer","description":"The start of the time range when a blocked email was created (inclusive). This is a unix timestamp."}},{"name":"end_time","in":"query","required":false,"description":"The end of the time range when a blocked email was created (inclusive). This is a unix timestamp.","schema":{"type":"integer","description":"The end of the time range when a blocked email was created (inclusive). This is a unix timestamp."}},{"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":"email","in":"query","required":false,"description":"Specifies which records to return based on the records' associated email addresses. For example, `sales` returns records with email…","schema":{"type":"string","description":"Specifies which records to return based on the records' associated email addresses. For example, `sales` returns records with email…"}},{"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-suppressions-v3/delete-suppression-blocks":{"post":{"operationId":"communication_sendgrid_suppressions_v3_delete_suppression_blocks","summary":"Delete blocks","description":"DELETE /v3/suppression/blocks","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-suppressions-v3/get-suppression-block":{"get":{"operationId":"communication_sendgrid_suppressions_v3_get_suppression_block","summary":"Retrieve a specific block","description":"GET /v3/suppression/blocks/{email}","tags":["communication"],"parameters":[{"name":"email","in":"query","required":true,"description":"The email address of the specific block.","schema":{"type":"string","description":"The email address of the specific block."}},{"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-suppressions-v3/delete-suppression-block":{"post":{"operationId":"communication_sendgrid_suppressions_v3_delete_suppression_block","summary":"Delete a specific block","description":"DELETE /v3/suppression/blocks/{email}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","description":"The email address of the specific block."},"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-suppressions-v3/list-suppression-bounces":{"get":{"operationId":"communication_sendgrid_suppressions_v3_list_suppression_bounces","summary":"Retrieve all bounces","description":"GET /v3/suppression/bounces","tags":["communication"],"parameters":[{"name":"start_time","in":"query","required":false,"description":"Refers start of the time range in unix timestamp when a bounce was created (inclusive).","schema":{"type":"integer","description":"Refers start of the time range in unix timestamp when a bounce was created (inclusive)."}},{"name":"end_time","in":"query","required":false,"description":"Refers end of the time range in unix timestamp when a bounce was created (inclusive).","schema":{"type":"integer","description":"Refers end of the time range in unix timestamp when a bounce was created (inclusive)."}},{"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":"email","in":"query","required":false,"description":"Specifies which records to return based on the records' associated email addresses. For example, `sales` returns records with email…","schema":{"type":"string","description":"Specifies which records to return based on the records' associated email addresses. For example, `sales` returns records with email…"}},{"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-suppressions-v3/delete-suppression-bounces":{"post":{"operationId":"communication_sendgrid_suppressions_v3_delete_suppression_bounces","summary":"Delete bounces","description":"DELETE /v3/suppression/bounces","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-suppressions-v3/get-suppression-bounces":{"get":{"operationId":"communication_sendgrid_suppressions_v3_get_suppression_bounces","summary":"Retrieve a Bounce","description":"GET /v3/suppression/bounces/{email}","tags":["communication"],"parameters":[{"name":"email","in":"query","required":true,"description":"The email address of the specific bounce you would like to retrieve","schema":{"type":"string","description":"The email address of the specific bounce you would like to retrieve"}},{"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-suppressions-v3/delete-suppression-bounce":{"post":{"operationId":"communication_sendgrid_suppressions_v3_delete_suppression_bounce","summary":"Delete a bounce","description":"DELETE /v3/suppression/bounces/{email}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","description":"The email address you would like to remove from the bounce list."},"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-suppressions-v3/list-suppression-bounces-classifications":{"get":{"operationId":"communication_sendgrid_suppressions_v3_list_suppression_bounces_classifications","summary":"Retrieve bounce classification totals","description":"GET /v3/suppression/bounces/classifications","tags":["communication"],"parameters":[{"name":"start_date","in":"query","required":false,"description":"The start of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive).","schema":{"type":"string","description":"The start of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive)."}},{"name":"end_date","in":"query","required":false,"description":"The end of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive).","schema":{"type":"string","description":"The end of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive)."}},{"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-suppressions-v3/get-suppression-bounces-classifications":{"get":{"operationId":"communication_sendgrid_suppressions_v3_get_suppression_bounces_classifications","summary":"Retrieve bounce classification over time by domain stats","description":"GET /v3/suppression/bounces/classifications/{classification}","tags":["communication"],"parameters":[{"name":"classification","in":"query","required":true,"description":"The classification you want to filter by. Possible values are: `Content`, `Frequency or Volume Too High`, `Invalid Address`, `Mailbox…","schema":{"type":"string","enum":["Content","Frequency or Volume Too High","Invalid Address","Mailbox Unavailable","Reputation","Technical Failure","Unclassified"],"description":"The classification you want to filter by. Possible values are: `Content`, `Frequency or Volume Too High`, `Invalid Address`, `Mailbox…"}},{"name":"start_date","in":"query","required":false,"description":"The start of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive).","schema":{"type":"string","description":"The start of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive)."}},{"name":"end_date","in":"query","required":false,"description":"The end of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive).","schema":{"type":"string","description":"The end of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive)."}},{"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-suppressions-v3/create-global-suppression":{"post":{"operationId":"communication_sendgrid_suppressions_v3_create_global_suppression","summary":"Add recipient addresses to the global suppression group.","description":"POST /v3/asm/suppressions/global","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-suppressions-v3/get-global-suppression":{"get":{"operationId":"communication_sendgrid_suppressions_v3_get_global_suppression","summary":"Retrieve a Global Suppression","description":"GET /v3/asm/suppressions/global/{email}","tags":["communication"],"parameters":[{"name":"email","in":"query","required":true,"description":"The email address of the global suppression you want to retrieve. Or, if you want to check if an email address is on the global…","schema":{"type":"string","description":"The email address of the global suppression you want to retrieve. Or, if you want to check if an email address is on the global…"}},{"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-suppressions-v3/delete-global-suppression":{"post":{"operationId":"communication_sendgrid_suppressions_v3_delete_global_suppression","summary":"Delete a Global Suppression","description":"DELETE /v3/asm/suppressions/global/{email}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","description":"The email address of the global suppression you want to retrieve. Or, if you want to check if an email address is on the global…"},"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-suppressions-v3/list-invalid-email":{"get":{"operationId":"communication_sendgrid_suppressions_v3_list_invalid_email","summary":"Retrieve all invalid emails","description":"GET /v3/suppression/invalid_emails","tags":["communication"],"parameters":[{"name":"start_time","in":"query","required":false,"description":"Refers start of the time range in unix timestamp when an invalid email was created (inclusive).","schema":{"type":"integer","description":"Refers start of the time range in unix timestamp when an invalid email was created (inclusive)."}},{"name":"end_time","in":"query","required":false,"description":"Refers end of the time range in unix timestamp when an invalid email was created (inclusive).","schema":{"type":"integer","description":"Refers end of the time range in unix timestamp when an invalid email was created (inclusive)."}},{"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":"email","in":"query","required":false,"description":"This parameter allows you to filter results by email address. Only invalid addresses matching an address passed in this parameter will be…","schema":{"type":"string","description":"This parameter allows you to filter results by email address. Only invalid addresses matching an address passed in this parameter will be…"}},{"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-suppressions-v3/delete-invalid-emails":{"post":{"operationId":"communication_sendgrid_suppressions_v3_delete_invalid_emails","summary":"Delete invalid emails","description":"DELETE /v3/suppression/invalid_emails","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-suppressions-v3/get-invalid-email":{"get":{"operationId":"communication_sendgrid_suppressions_v3_get_invalid_email","summary":"Retrieve a specific invalid email","description":"GET /v3/suppression/invalid_emails/{email}","tags":["communication"],"parameters":[{"name":"email","in":"query","required":true,"description":"The specific email address of the invalid email entry that you want to retrieve.","schema":{"type":"string","description":"The specific email address of the invalid email entry that you want to retrieve."}},{"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-suppressions-v3/delete-invalid-email":{"post":{"operationId":"communication_sendgrid_suppressions_v3_delete_invalid_email","summary":"Delete a specific invalid email","description":"DELETE /v3/suppression/invalid_emails/{email}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","description":"The specific email address of the invalid email entry that you want to retrieve."},"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-suppressions-v3/list-spam-report":{"get":{"operationId":"communication_sendgrid_suppressions_v3_list_spam_report","summary":"Retrieve all spam reports","description":"GET /v3/suppression/spam_reports","tags":["communication"],"parameters":[{"name":"start_time","in":"query","required":false,"description":"The start of the time range when a spam report was created (inclusive). This is a unix timestamp.","schema":{"type":"integer","description":"The start of the time range when a spam report was created (inclusive). This is a unix timestamp."}},{"name":"end_time","in":"query","required":false,"description":"The end of the time range when a spam report was created (inclusive). This is a unix timestamp.","schema":{"type":"integer","description":"The end of the time range when a spam report was created (inclusive). This is a unix timestamp."}},{"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":"email","in":"query","required":false,"description":"Specifies which records to return based on the records' associated email addresses. For example, `sales` returns records with email…","schema":{"type":"string","description":"Specifies which records to return based on the records' associated email addresses. For example, `sales` returns records with email…"}},{"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-suppressions-v3/delete-spam-reports":{"post":{"operationId":"communication_sendgrid_suppressions_v3_delete_spam_reports","summary":"Delete spam reports","description":"DELETE /v3/suppression/spam_reports","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-suppressions-v3/get-spam-report":{"get":{"operationId":"communication_sendgrid_suppressions_v3_get_spam_report","summary":"Retrieve a specific spam report","description":"GET /v3/suppression/spam_reports/{email}","tags":["communication"],"parameters":[{"name":"email","in":"query","required":true,"description":"The email address of a specific spam report that you want to retrieve.","schema":{"type":"string","description":"The email address of a specific spam report that you want to retrieve."}},{"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-suppressions-v3/delete-spam-report":{"post":{"operationId":"communication_sendgrid_suppressions_v3_delete_spam_report","summary":"Delete a specific spam report","description":"DELETE /v3/suppression/spam_reports/{email}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","description":"The email address of a specific spam report that you want to retrieve."},"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-suppressions-v3/list-global-suppression":{"get":{"operationId":"communication_sendgrid_suppressions_v3_list_global_suppression","summary":"Retrieve all global suppressions","description":"GET /v3/suppression/unsubscribes","tags":["communication"],"parameters":[{"name":"start_time","in":"query","required":false,"description":"Refers start of the time range in unix timestamp when an unsubscribe email was created (inclusive).","schema":{"type":"integer","description":"Refers start of the time range in unix timestamp when an unsubscribe email was created (inclusive)."}},{"name":"end_time","in":"query","required":false,"description":"Refers end of the time range in unix timestamp when an unsubscribe email was created (inclusive).","schema":{"type":"integer","description":"Refers end of the time range in unix timestamp when an unsubscribe email was created (inclusive)."}},{"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":"email","in":"query","required":false,"description":"Specifies which records to return based on the records' associated email addresses. For example, `sales` returns records with email…","schema":{"type":"string","description":"Specifies which records to return based on the records' associated email addresses. For example, `sales` returns records with email…"}},{"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"}}},"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"}}}}}}}